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

以下の節では、WLST コマンドと変数について詳細に説明します。以下のトピックがあります。

• WSLT コマンド カテゴリの概要

• 参照コマンド

• 制御コマンド

• カスタマイズ コマンド

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

• 診断コマンド

• 編集コマンド

• 情報コマンド

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

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

• ツリー コマンド

• WLST 変数リファレンス

WSLT コマンド カテゴリの概要

注意 : コマンドの構文の要件について、『Oracle Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「WLST コマンドの構文」を参照しておくことをお勧めします。

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

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

コマンド カテゴリ	説明
参照コマンド	コンフィグレーション Bean または実行時 Bean の階層を移動する。プロンプトの表示を制御する。
制御コマンド	サーバに接続したり、サーバへの接続を切断したりする。 WebLogic ドメインまたはドメイン テンプレートを作成およびコンフィグレーションする。 WLST を終了する。
カスタマイズ コマンド	WLST help() および help('commandGroup') コマンドによって表示されるコマンド グループ ヘルプおよびコマンド ヘルプを追加する。
デプロイメント コマンド	アプリケーションとスタンドアロン モジュールを WebLogic Server インスタンスにデプロイ、アンデプロイ、および再デプロイする。 既存のデプロイメント プランを更新する。 WebLogic デプロイメント マネージャ オブジェクトに照会する。 デプロイされたアプリケーションを起動および停止する。
診断コマンド	診断データをエクスポートする。
編集コマンド	コンフィグレーション Bean の照会や編集を行う。
情報コマンド	ドメイン、サーバ、変数に照会する。コンフィグレーション Bean、実行時 Bean、WLST に関連した情報を提供する。
ライフサイクル コマンド	サーバ インスタンスのライフサイクルを管理する。
ノード マネージャ コマンド	ノード マネージャを使用して、WebLogic Server インスタンスを起動、停止、再起動、およびモニタする。
ツリー コマンド	MBean 階層内を移動する。

参照コマンド

表 3-13 に示す 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 Fusion Middleware 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-13 に示す WLST 制御コマンドを使用して、以下のタスクを行います。

• サーバに接続したり、サーバへの接続を切断したりする

• コンフィグレーション ウィザードと同様に、WebLogic ドメインまたはドメイン テンプレートを作成およびコンフィグレーションする

• WLST を終了する

表 3-13 に、WLST コンフィグレーションの制御コマンドを示します。

表 3-3 WLST コンフィグレーションの制御コマンド

コマンド	説明	WLST の使用状況
connect	WLST を WebLogic Server インスタンスに接続する。	オンラインまたはオフライン
disconnect	WLST を WebLogic Server インスタンスから接続解除する。	オンライン
createDomain	指定されたテンプレートを使用して新しいドメインを作成する。	オフライン
readTemplate	ドメインを作成するために既存のドメイン テンプレートを開く。	オフライン
writeDomain	指定されたディレクトリにドメインのコンフィグレーション情報を書き込む。	オフライン
closeTemplate	現在のドメイン テンプレートを閉じる。	オフライン
readDomain	更新するために既存のドメインを開く。	オフライン
addTemplate	アプリケーションまたはサービスの拡張テンプレートを使用して、現在のドメインを拡張する。	オフライン
updateDomain	現在のドメインを更新して保存する。	オフライン
closeDomain	現在のドメインを閉じる。	オフライン
writeTemplate	指定されたドメイン テンプレート ファイルにコンフィグレーション情報を書き込む。	オフライン
exit	WLST を対話セッションから終了させて、スクリプト シェルを閉じる。	オンラインまたはオフライン

addTemplate

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

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

説明

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

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

構文

addTemplate(templateFileName)

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

例

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

wls:/offline> readDomain('c:/bea/user_projects/domains/wlw')
wls:/offline/wlw> addTemplate('c:/bea/wlserver_10.3/common/templates/
applications/DefaultWebApp.jar')
wls:/offline/wlw> 

closeDomain

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

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

説明

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

構文

closeDomain()

例

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

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

closeTemplate

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

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

説明

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

構文

closeTemplate()

例

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

wls:/offline> readTemplate('c:/bea/wlserver_10.3/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 ファイルに格納します。

ユーザ名とパスワード、またはユーザ コンフィグレーション ファイルとキー ファイルを指定しないで connect コマンドを実行した場合、WLST は以下のいずれかの方法を順次使用してコマンドを処理しようとします。

1. ユーザ コンフィグレーション ファイルとデフォルトのキー ファイルがホーム ディレクトリに存在する場合、それらのファイルを使用します。ホーム ディレクトリの場所は、WLST が実行されているオペレーティング システムのタイプによって異なります。デフォルトの場所については、「storeUserConfig」を参照してください。

2. adminServerName 引数が指定されていない場合、./boot.properties または ./servers/myserver/security/boot.properties にある boot.properties ファイルを検索します。

3. adminServerName 引数が指定されている場合、/servers/adminServerName/security/boot.properties にある boot.properties を検索します。ここで、adminServerName は、adminServerName 引数の値です。

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

• 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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「対話モードまたはスクリプト モードでの WLST の使用の主な手順」を参照してください。

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

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 weblogic server instance running at t3://localhost:7001 as
username ...

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

createDomain

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

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

説明

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

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

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

構文

createDomain(domainTemplate, domainDir, user, password) 

引数	定義
domainTemplate	作成するドメインの基になるドメイン テンプレートの名前および場所。
domainDir	ドメイン コンフィグレーション情報を書き込むディレクトリの名前。
user	デフォルト ユーザの名前。
password	デフォルト ユーザのパスワード。

例

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

wls:/offline> createDomain('c:/bea/wlserver_10.3/common/templates/domains
/wls_medrec.jar','c:/bea/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 の使用状況 : オフライン

説明

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

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

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

wls:/offline/base_domain>

詳細については、『Oracle Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「MBean の移動と照会」を参照してください。

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

構文

readDomain(domainDirName)

引数	定義
domainDirName	開くドメイン ディレクトリの名前。

例

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

wls:/offline> readDomain('c:/bea/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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「MBean の移動と照会」を参照してください。

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

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

構文

readTemplate(templateFileName)

引数	定義
templateFileName	ドメイン テンプレートに相当する JAR ファイルの名前。

例

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

wls:/offline> readTemplate('c:/bea/wlserver_10.3/common/templates/domains
/wls_medrec.jar') 
wls:/offline/wls_medrec>

updateDomain

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

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

説明

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

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

構文

updateDomain()

例

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

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

writeDomain

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

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

説明

指定されたディレクトリにドメインのコンフィグレーション情報を書き込みます。

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

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

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

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

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

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

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

構文

writeDomain(domainDir)

引数	定義
domainDir	ドメイン コンフィグレーション情報を書き込むディレクトリの名前。

例

以下の例では、medrec.jar ドメイン テンプレートを読み込み、いくつかのオペレーションを実行してから、ドメイン コンフィグレーション情報を c:/bea/user_projects/domains/medrec ディレクトリに書き込みます。

wls:/offline> readTemplate('c:/bea/wlserver_10.3/common/templates/domains
/wls.jar') 
...
wls:/offline/base_domain> writeDomain('c:/bea/user_projects/domains/base_domain') 

writeTemplate

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

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

説明

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

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

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

注意 : writeTemplate コマンドは、『pack および unpack コマンドを使用したテンプレートとドメインの作成』の「pack コマンド」で説明されているように、pack コマンドに類似した機能を備えています。ただし、writeTemplate は管理対象サーバ テンプレートの作成をサポートしていません。

構文

writeTemplate(templateName)

引数	定義
templateName	ドメイン コンフィグレーション情報を格納するドメイン テンプレートの名前。

例

以下の例では、現在のドメイン コンフィグレーションを c:/bea/user_projects/templates/myTemplate.jar というドメイン テンプレートに書き込みます。

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

カスタマイズ コマンド

表 3-4 に示す WLST カスタマイズ コマンドを使用して、WLST help() および help('commandGroup') コマンドによって表示されるコマンド グループ ヘルプおよびコマンド ヘルプを追加します。WLST へのコマンド ヘルプの追加の詳細については、『Oracle Fusion Middleware 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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「カスタム コマンドの統合ヘルプの追加」を参照してください。 resourceBundles およびローカライゼーションの詳細については、http://java.sun.com/javase/6/docs/api/java/util/ResourceBundle.html を参照してください。

例

次の例では、help() コマンドで表示されたグループの一覧に boot コマンド グループを追加し、ヘルプ テキストがプロパティ リソース ファイル 'myhelp' に格納されていることを指定します。

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

次の例では、help() コマンドで表示されるグループの一覧に boot コマンド グループを追加し、ヘルプ テキストがクラス 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。
オンライン	省略可能。help('online') 出力にコマンドを表示するかどうかを判断するブール値。デフォルト値は 'false'。
オフライン	省略可能。help('offline') 出力にコマンドを表示するかどうかを判断するブール値。デフォルト値は 'false'。

例

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

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

デプロイメント コマンド

表 3-13 に示す WLST デプロイメント コマンドを使用します。

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

• 既存のデプロイメント プランを更新する。

• WebLogic デプロイメント マネージャ オブジェクトに照会する。

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

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

表 3-5 WLST コンフィグレーションのデプロイメント コマンド

コマンド	説明	WLST の使用状況
deploy	WebLogic Server インスタンスにアプリケーションをデプロイする。	オンライン
distributeApplication	指定された対象にデプロイメント バンドルをコピーする。	オンライン
getWLDM	WebLogic DeploymentManager オブジェクトを返す。	オンライン
listApplications	ドメイン内に現在デプロイされているすべてのアプリケーションをリストする。	オンライン
loadApplication	アプリケーションとデプロイメント プランをメモリにロードする。	オンライン
redeploy	以前にデプロイされたアプリケーションを再デプロイする。	オンライン
startApplication	アプリケーションを起動して、ユーザが利用できるようにする。	オンライン
stopApplication	アプリケーションを停止して、ユーザが利用できないようにする。	オンライン
undeploy	指定されたサーバからアプリケーションをアンデプロイする。	オンライン
updateApplication	新しいデプロイメント プランを使用してアプリケーションのコンフィグレーションを更新する。	オンライン

deploy

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

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

説明

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

deploy コマンドは、コマンドのステータスをチェックするためにアクセスできる WLSTProgress オブジェクトを返します。WLSTProgress オブジェクトの詳細については、『Oracle Fusion Middleware 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 Fusion Middleware Oracle WebLogic Server　アプリケーションのデプロイメント』の「ステージング モードによるデプロイメント ファイルのコピーの制御」を参照。この引数のデフォルトは null。
planPath	省略可能。デプロイメント プラン ファイルの名前。ファイル名は絶対パスでも、アプリケーション ディレクトリを基準とした相対パスでもよい。この引数のデフォルトは、アプリケーション ディレクトリの plan/plan.xml ファイル (存在する場合)。
options	省略可能。デプロイメント オプションのカンマ区切りのリスト。名前と値のペアで指定する。有効なオプションは次のとおり。 altDD - 管理サーバにある、代替アプリケーション デプロイメント記述子の場所。 altWlsDD - 管理サーバにある、代替 WebLogic アプリケーション デプロイメント記述子の場所。 archiveVersion - アーカイブのバージョン番号。 block - コマンドが完了するまで WLST がユーザ対話をブロックするかどうかを指定するブール値。このオプションのデフォルトは true。false に設定した場合、WLST はコマンドの発行後に制御をユーザに返す。WLSTProgress オブジェクトに問い合わせて、コマンドのステータスを調べることができる。『Oracle Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「Jython モジュールとしての WLST のインポート」で説明するように、WLST を Jython モジュールとしてインポートしている場合、block は常に true に設定される。 clusterDeploymentTimeout - このアプリケーションでクラスタのデプロイメント タスクに認められた時間 (ミリ秒単位)。 createPlan - ユーザがデフォルト プランを作成するかどうかを示すブール値。このオプションのデフォルトは false。 defaultSubmoduleTargets — 適格 JMS サブモジュールの対象指定がシステムによって行われるかどうかを示すブール値。『Oracle Fusion Middleware Oracle WebLogic Server　アプリケーションのデプロイメント』の「JMS アプリケーション モジュールにおけるサブモジュールの対象指定の使用」を参照。デフォルト値は true。 deploymentPrincipalName - 起動および停止時にファイルまたはアーカイブをデプロイするときに使用されるプリンシパルを示す文字列値。静的デプロイメントであるため、現在のデプロイメント タスクには影響を与えない。ユーザの存在を確認すること。このオプションによって、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 モジュールのサブモジュール レベルの対象。[e-mail]@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 Fusion Middleware 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 Fusion Middleware Oracle WebLogic Server アプリケーションのデプロイメント』の「プロダクション環境でのアプリケーションの再デプロイメント」を参照してください。

distributeApplication

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

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

説明

指定された対象にデプロイメント バンドルをコピーします。デプロイメント バンドルにはモジュール、コンフィグレーション データ、その他の生成コードが含まれます。distributeApplication コマンドではデプロイメントは開始されません。

distributeApplication コマンドは、コマンドのステータスをチェックするためにアクセスできる WLSTProgress オブジェクトを返します。WLSTProgress オブジェクトの詳細については、『Oracle Fusion Middleware 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 Fusion Middleware 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 の使用状況 : オンライン

説明

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

エラーが発生した場合は、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 Fusion Middleware 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:/myserver/serverConfig> 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.
wls:/myserver/serverConfig>

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

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

WLSTPlan オブジェクトの詳細については、『Oracle Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「WLSTPlan オブジェクト」を参照してください。

redeploy

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

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

説明

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

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

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

アプリケーションの再デプロイの詳細については、『Oracle Fusion Middleware 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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「WLSTProgress オブジェクト」を参照してください。

startApplication

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

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

説明

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

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

構文

startApplication(appName, [options])

引数	定義
appName	plan.xml ファイルに指定されている、起動するアプリケーションの名前。
options	省略可能。デプロイメント オプションのカンマ区切りのリスト。名前と値のペアで指定する。有効なデプロイメント オプションのリストについては、「deploy」の options 引数の説明を参照。

例

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

wls:/offline> progress=startApplication('BigApp', stageMode='NOSTAGE', testMode='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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「WLSTProgress オブジェクト」を参照してください。

stopApplication

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

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

説明

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

stopApplication コマンドは、コマンドのステータスをチェックするためにアクセスできる WLSTProgress オブジェクトを返します。WLSTProgress オブジェクトの詳細については、『Oracle Fusion Middleware 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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「WLSTProgress オブジェクト」を参照してください。

undeploy

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

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

説明

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

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

アプリケーションのデプロイおよびアンデプロイの詳細については、『Oracle Fusion Middleware 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 の使用状況 : オンライン

説明

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

updateApplication コマンドは、コマンドのステータスをチェックするためにアクセスできる WLSTProgress オブジェクトを返します。WLSTProgress オブジェクトの詳細については、『Oracle Fusion Middleware 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', testMode='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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「WLSTProgress オブジェクト」を参照してください。

診断コマンド

表 3-13 に示す WLST 診断コマンドを使用し、WebLogic 診断フレームワーク (WLDF) のデータ ストアに対してクエリを実行することによって、診断データを取得できます。WLDF の詳細については、『Oracle Fusion Middleware Oracle WebLogic Server のコンフィグレーションと診断フレームワークの使い方』を参照してください。

表 3-6 WLST コンフィグレーションの診断コマンド

コマンド	説明	WLST の使用状況
exportDiagnosticData	指定されたログ ファイルに対するクエリを実行する。	オフライン
exportDiagnosticDataFromServer	サーバ サイドでクエリを実行して、エクスポートされた WebLogic 診断フレームワーク (WLDF) データを取得する。	オンライン

exportDiagnosticData

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

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

説明

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

WebLogic Server 診断サービスの詳細については、『Oracle Fusion Middleware 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 Fusion Middleware 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:\bea\wlserver_10.3\server\data\store\diagnostics"
 writePolicy="Disabled" blockSize=512 directIO=false driver="wlfileio2">

wls:/mydomain/serverRuntime>

exportDiagnosticDataFromServer

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

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

説明

サーバ サイドでクエリを実行して、エクスポートされた WebLogic 診断フレームワーク (WLDF) データを取得します。結果は XML ファイルとして保存されます。

WebLogic Server 診断サービスの詳細については、『Oracle Fusion Middleware 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") 

編集コマンド

表 3-13 に示す WLST 編集コマンドを使用して、コンフィグレーション Bean の照会や編集を行います。

注意 : コンフィグレーション Bean を編集するには、管理サーバに接続している必要があります。また、編集ツリーに移動して、編集セッションを開始する必要があります。「edit」および「startEdit」をそれぞれ参照してください。 管理対象サーバに接続した場合、WLST の機能はコンフィグレーション Bean 階層の参照だけに制限されます。WLST を使用して管理対象サーバ上の MBean の値を変更することはできませんが、管理 API を使用すれば可能です。ただし、管理サーバ上のコンフィグレーション MBean の値のみを変更することをお勧めします。管理対象サーバ上の MBean の値を変更すると、ドメイン コンフィグレーションに矛盾が生じる可能性があります。 コンフィグレーション Bean の編集に関する詳細については、『Oracle Fusion Middleware 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	ドメインの作成または更新に関連するオプションを設定する。	オフライン
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 Fusion Middleware 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 など)。
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 Fusion Middleware 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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「WLST サンプル スクリプト」を参照)。

• MBean とその子タイプ、属性、オペレーションについては、『Oracle Fusion Middleware Oracle WebLogic Server MBean リファレンス』を参照。

構文

create(name, childMBeanType, [baseProviderType])

引数	定義
name	作成するコンフィグレーション Bean の名前。
childMBeanType	作成するコンフィグレーション Bean のタイプ。config.xml ファイルに定義されたタイプのインスタンスを作成できる (カスタム セキュリティ タイプは除く)。有効なコンフィグレーション Bean の詳細については、『Oracle Fusion Middleware 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') 

以下の例では、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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「現在の管理オブジェクトの変更」を参照してください。

構文

delete(name, childMBeanType)

引数	定義
name	削除する子コンフィグレーション Bean の名前。
childMBeanType	削除するコンフィグレーション Bean のタイプ。config.xml ファイルで定義されたタイプのインスタンスを削除できる。有効なコンフィグレーション Bean の詳細については、『Oracle Fusion Middleware 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 の使用状況 : オンライン

説明

指定された文字列を暗号化します。暗号化した文字列は、コンフィグレーション ファイルやコマンドの引数として使用できます。

このコマンドは、暗号化された文字列を使用する必要のある各ドメインにつき 1 回呼び出す必要があります。暗号化された文字列は、その文字列が元々暗号化されたドメインでのみ使用できます。

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

構文

encrypt(obj, [domainDir])

引数	定義
obj	暗号化する文字列。
domainDir	省略可能。ドメイン ディレクトリの絶対パス名。暗号化された文字列は、指定したディレクトリ内にあるドメインでのみ使用できる。 この引数を指定しない場合、WLST が現在接続されているドメインで使用されるために文字列が暗号化される。

例

以下の例では、指定されたドメイン ディレクトリにある security/SerializedSystemIni.dat ファイルを使用して、指定された文字列を暗号化します。

wls:/mydomain/serverConfig> es=encrypt('myPassword','c:/bea/domains/mydomain') 

get

コマンド カテゴリ : 編集コマンド

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

説明

指定された属性の値を返します。表示できる MBean 属性の詳細については、『Oracle WebLogic Server MBean リファレンス』を参照してください。エラーが発生した場合は、WLSTException が返されます。

注意 : ls('a') と入力すると、すべての属性とその現在の値を表示できます。詳細については、「ls」を参照してください。

代わりに、cmo 変数を使用して、現在のコンフィグレーション Bean の任意の get メソッドを実行できます。次に例を示します。

cmo.getListenPort()

cmo 変数の詳細については、『Oracle Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「現在の管理オブジェクトの変更」を参照してください。

構文

get(attrName)

引数	定義
attrName	表示する属性の名前。属性の絶対パス名を指定できる。パス名を指定しない場合は、現在のコンフィグレーション オブジェクトの属性が表示される。

例

以下の例では、現在のコンフィグレーション Bean の AdministrationPort の値を返します。

wls:/mydomain/serverConfig> get('AdministrationPort') 
9002

代わりに、cmo 変数を使用できます。

cmo.getAdministrationPort()

getActivationTask

コマンド カテゴリ : 編集コマンド

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

説明

ユーザがステータスを取得できる最新の ActivationTask MBean を返します。ActivationTask MBean には、ユーザが最近行った変更の状態が反映されています。メソッドを呼び出して、進行中または完了したばかりの、最近のコンフィグレーション マネージャのアクティブ化タスクに関する情報を取得できます。エラーが発生した場合は、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 を見つけます。たとえば、PointBase バージョン 4.4 の場合、SQL ファイル リストは _jdbc_\Pointbase\44\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 Fusion Middleware 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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「暗号化されたコンフィグレーション値の読み書き」を参照してください。

WLST オンラインを使用する場合は以下の点に注意してください。

• このコマンドを使用するには、編集セッションに移動する必要がある。「startEdit」を参照。

• このコマンドは、WLST が管理対象サーバに接続しているときには使用できない。

• このコマンドの代替手段として、次の構文で cmo 変数を使用できる。

• cmo.setattrName(value)

  たとえば、set('ListenPort', 7011) を使用する代わりに、cmo.setListenPort(7011) を使用できます。

  cmo 変数の詳細については、『Oracle Fusion Middleware 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 の使用状況 : オフライン

説明

ドメインの作成または更新に関連するオプションを設定します。エラーが発生した場合は、WLSTException が返されます。

構文

setOption(optionName, op          tionValue)

引数	定義
optionName	設定するオプションの名前。 ドメインの作成で使用できるオプションは次のとおり。 CreateStartMenu - Windows プラットフォームの [スタート] メニューにショートカットを作成するかどうかを指定するブール値。このオプションのデフォルトは true。 注意 : 管理者権限を持つユーザがソフトウェアをインストールして、[All Users] フォルダに [スタート] メニューのエントリを作成した場合は、管理者権限を持つユーザのみが、コンフィグレーション ウィザードまたは WLST を使用してドメインを作成するときに、同じフォルダに [スタート] メニューのエントリを作成できる。つまり、管理者権限を持たないユーザが、このインストールからコンフィグレーション ウィザードまたは WLST を使用してドメインを作成しても、そのドメインへの [スタート] メニューのショートカットは作成されない。この場合は、必要に応じて、ローカルの [スタート メニュー] フォルダに手動でショートカットを作成できる。 DomainName - ドメインの名前。デフォルトでは、ドメインの名前はドメイン ディレクトリの名前から取られる。たとえば、ドメインが c:/bea/user_projects/domains/myMedrec に保存される場合、ドメイン名は myMedrec になる。DomainName を設定すると、作成されたドメインの名前がドメイン ディレクトリ名に依存することはなくなる。 JavaHome - サーバの起動時に使用する JVM のホーム ディレクトリ。このオプションのデフォルトは、WebLogic Server をインストールしているプラットフォームによって異なる。 OverwriteDomain - 既存のドメインを上書き可能にするかどうかを指定するブール値。このオプションのデフォルトは false。 ServerStartMode - 新規作成したドメインでサーバを起動するときに使用するモード。この値は、dev (開発) または prod (プロダクション) に設定できる。このオプションのデフォルトは dev。 ドメインの更新で使用できるオプションは次のとおり。 AllowCasualUpdate - 拡張テンプレートを追加せずに、ドメインの更新を許可するかどうかを指定するブール値。このオプションのデフォルトは true。 ReplaceDuplicates - 衝突があった場合に、ドメインの元のコンフィグレーションの要素を保持するか、拡張テンプレートの対応する要素で置き換えるかを指定するブール値。このオプションのデフォルトは true。 ドメインの作成とドメインの更新の両方で使用できるオプションは次のとおり。 AppDir - 指定されたテンプレートに従って、アプリケーションに別のディレクトリが必要な場合に使用するアプリケーション ディレクトリ。このオプションのデフォルトは BEAHOME/user_projects/applications/domainname。BEAHOME には BEA ホーム ディレクトリ、domainname にはドメインの名前を指定する。 AutoAdjustSubDeploymentTarget - WLST が、AppDeployments のサブデプロイメントの対象を自動的に調整するかどうかを指定するブール値。このオプションのデフォルトは true。この機能を無効にするには、オプションを false に設定して、ドメインまたはドメイン テンプレートを書き込むか更新する前に、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」を参照してください。

ドメイン コンフィグレーションを変更するコマンドを呼び出す前に、このコマンドを呼び出す必要があります。

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

注意 : 同じユーザによる進行中の編集セッションがあることを検出した場合、WLST は自動的に編集セッションを開始します。進行中のセッションは Administration Console または別の 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-13 に示す 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:\bea\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:\bea\user_projects\domains\wls\config\config.py
and the properties file associated with this script is written to c:\bea\user_projects\domains\wls\config\config.py.properties
wls:/offline>

以下の例では、c:\bea\user_projects\domains\mydomain\config ディレクトリにあるファイルでコンフィグレーションされたサーバ リソースを、WLST スクリプト c:\bea\myscripts\config.py に変換します。

wls:/offline> configToScript('c:/bea/user_projects/domains/mydomain',
'c:/bea/myscripts') 
configToScript is loading configuration from c:\bea\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:\bea\myscripts\config.py
and the properties file associated with this script is written to c:\bea\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 を返します。そのメソッドを呼び出して、ドメイン内のコンフィグレーションの変更を管理できます。エラーが発生した場合は、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 Fusion Middleware 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 Fusion Middleware Oracle WebLogic Scripting Tool』の「暗号化されたコンフィグレーション値の読み書き」を参照。)

• 項目がオペレーションである場合、3 列目には、次の形式でそのオペレーションの戻り値の型と入力パラメータが表示される。returnType: parameterType(parameterName)

表 3-9 ls コマンドの出力情報

コード	説明
d	項目が子の管理オブジェクトであることを示す。 UNIX または Windows のファイル システムにおけるディレクトリと同様に、cd コマンドを使用して子オブジェクトを現在の管理オブジェクトにすることができる。
r	項目が子の管理オブジェクト、または読み取り可能な属性であることを示す (セキュリティ レルムのポリシーによって現在のユーザに読み取りパーミッションが付与されていることが前提)。(『Oracle Fusion Middleware Oracle WebLogic Server MBean リファレンス』の「Default Security Policies For MBeans」を参照)。
w	項目が書き込み可能な属性であることを示す (セキュリティ レルムのポリシーによって現在のユーザに書き込みパーミッションが付与されていることが前提)。(『Oracle WebLogic Server MBean Reference』の「Default Security Policies For MBeans」を参照)。
x	項目が実行可能なオペレーションであることを示す (セキュリティ レルムのポリシーによって現在のユーザに実行パーミッションが付与されていることが前提)。(『Oracle Fusion Middleware Oracle WebLogic Server MBean リファレンス』の「Default Security Policies For MBeans」を参照)。

デフォルトの出力では、現在の管理オブジェクトのすべての属性、オペレーション、および子の管理オブジェクトがリストされます。出力をフィルタリングする、または異なる管理オブジェクトのリストを表示するには、コマンドの引数を指定します。

WLST オフラインを使用する場合は以下の点に注意してください。

• WebLogic Server のデフォルト値のほとんどは、パフォーマンスを最適化するため、ドメインのコンフィグレーション ファイルには保持されていません。この最適化が原因で、WLST オフラインでは管理オブジェクト全体を表示できない場合があります (WebLogic Server では対応する XML 要素をドメインのコンフィグレーション ファイルに書き込んでいないため)。たとえば、ドメインがアクティブであるときにドメインのロギングのデフォルト重大度を変更しなかった場合、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 Fusion Middleware 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 Fusion Middleware 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 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 が接続しているサーバになる。 管理サーバに接続している場合は、管理サーバと、ドメインで動作している任意の管理対象サーバのスレッド ダンプを表示できる。管理対象サーバに接続している場合は、その管理対象サーバのスレッド ダンプのみを表示できる。

例

以下の例では、現在のサーバのスレッド ダンプを表示して、出力を 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 Fusion Middleware 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-13 に示す WLST ライフサイクル コマンドを使用して、サーバ インスタンスのライフサイクルを管理します。

サーバ インスタンスのライフサイクルの詳細については、『Oracle Fusion Middleware Oracle WebLogic Server サーバの起動と停止』の「サーバのライフサイクルについて」を参照してください。

表 3-10 WLST コンフィグレーションのライフサイクル コマンド

コマンド	説明	WLST の使用状況
migrate	クラスタ内の対象サーバにサービスを移行する。	オンライン
resume	中断された、または ADMIN 状態にあるサーバ インスタンスを再開する。	オンライン
shutdown	実行中のサーバ インスタンスまたはクラスタを正常に停止する。	オンライン
start	ノード マネージャを使用して管理対象サーバ インスタンスまたはクラスタを起動する。	オンライン
startServer	管理サーバを起動する。	オンラインまたはオフライン
suspend	実行中のサーバを中断する。	オンライン

migrate

コマンド カテゴリ : ライフサイクル コマンド

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

説明

指定されたサービス (JTA、JMS、またはサーバ) を、クラスタ内の対象のサーバに移行します。エラーが発生した場合は、WLSTException が返されます。

サービスの移行については、『Oracle Fusion Middleware Oracle WebLogic Server クラスタの使い方』の「サービスの移行」を参照してください。

構文

migrate(sname, destinationName, [sourceDown], [destinationDown], [migrationType])

引数	定義
sname	サービスの移行元になるサーバの名前。
destinationName	サービスの移行先となるマシンまたはサーバの名前。
sourceDown	省略可能。元のサーバが停止しているかどうかを示すブール値。この引数のデフォルトは true で、元のサーバが動作していないことを示す。 JTA サービスを移行する場合、sourceDown 引数は指定されていても無視されて、デフォルトの true になる。JTA サービスを正常に移行するには、元のサーバが停止している必要がある。
destinationDown	省略可能。移行先のサーバが停止しているかどうかを示すブール値。この引数のデフォルトは false で、移行先のサーバが動作してることを示す。 移行先のサーバが動作していない場合に、この引数を true に設定すると、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 Fusion Middleware Oracle WebLogic Server サーバの起動と停止』の「サーバのライフサイクルについて」を参照してください。

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

構文

resume([sname], [block])

引数	定義
sname	再開するサーバの名前。この引数のデフォルトは、WLST が現在接続しているサーバになる。
block	省略可能。サーバが再開されるまで WLST がユーザ対話をブロックするかどうかを指定するブール値。この引数のデフォルトは false で、ユーザ対話がブロックされないことを示す。この場合、WLST はコマンドを発行した後でユーザに制御を返し、現在のタスクに関連付けられているタスク MBean を変数に割り当てる。その変数を利用すると、タスクのステータスをチェックできる。『Oracle Fusion Middleware 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 Fusion Middleware 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 Fusion Middleware 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 が返されます。

構文

startServer([adminServerName], [domainName], [url], [username], [password],
[domainDir], [block], [timeout], [serverLog], [systemProperties], [jvmArgs] [spaceAsJvmArgsDelimiter])

引数	定義
adminServerName	省略可能。起動する管理サーバの名前。この引数のデフォルトは myserver。
domainName	省略可能。管理サーバが属しているドメインの名前。この引数のデフォルトは mydomain。
url	省略可能。管理サーバの URL。startServer コマンドに指定した URL によって、config.xml ファイルに指定されたリスン アドレスとリスン ポートが上書きされる。この引数がコマンドラインまたは config.xml ファイルに指定されていない場合は、デフォルトの t3://localhost:7001 が使用される。
username	省略可能。WLST をサーバに接続するときのユーザ名。この引数のデフォルトは weblogic。
password	省略可能。WLST をサーバに接続するときのパスワード。この引数のデフォルトは weblogic。
domainDir	省略可能。管理サーバが起動されるドメイン ディレクトリ。この引数のデフォルトは、WLST の起動元ディレクトリ。
block	省略可能。サーバが起動されるまで WLST がユーザ対話をブロックするかどうかを指定するブール値。block が false に設定された場合、WLST はこのコマンドを発行した後でユーザに制御を返します。この引数のデフォルトは true で、ユーザ対話がブロックされることを示す。『Oracle Fusion Middleware 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 Fusion Middleware 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 Fusion Middleware Oracle WebLogic Scripting Tool ガイド』の「Jython モジュールとしての WLST のインポート」で説明するように、WLST を Jython モジュールとしてインポートしている場合、block は常に true に設定される。

例

以下の例では、管理対象サーバ インスタンスを中断します。

wls:/mydomain/serverConfig> suspend('managed1') 
Server 'managed1' suspended successfully.
wls:/mydomain/serverConfig>

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

表 3-13 に示す WLST ノード マネージャ コマンドを使用して、WebLogic Server インスタンスを起動、停止、再起動、およびモニタします。

このカテゴリのコマンドを実行する前に、ノード マネージャを実行する必要があります。

ノード マネージャの詳細については、『Oracle Fusion Middleware Oracle WebLogic Server ノードマネージャ管理者ガイド』の「ノード マネージャの使用」を参照してください。

表 3-11 WLST コンフィグレーションのノード マネージャ コマンド

コマンド	説明	WLST の使用状況
nm	WLST がノード マネージャに接続しているかどうかを判断する。	オンライン
nmConnect	WLST をノード マネージャに接続してセッションを確立する。	オンラインまたはオフライン
nmDisconnect	WLST をノード マネージャ セッションから接続解除する。	オンラインまたはオフライン
nmEnroll	これにより、現在のコンピュータ上のノード マネージャが指定されたドメインにサーバを管理できるようになります。	オンライン
nmGenBootStartupProps	指定されたサーバのためのノード マネージャ プロパティ ファイル boot.properties および startup.properties を生成します。	オンライン
nmKill	ノード マネージャで起動された、指定されたサーバ インスタンスを強制停止する。	オンラインまたはオフライン
nmLog	ノード マネージャ ログを返す。	オンラインまたはオフライン
nmServerLog	ノード マネージャで起動されたサーバのサーバ出力ログを返す。	オンラインまたはオフライン
nmServerStatus	ノード マネージャで起動されたサーバのステータスを返す。	オンラインまたはオフライン
nmStart	ノード マネージャを使用して、現在のドメイン内のサーバを起動する。	オンラインまたはオフライン
nmVersion	ノード マネージャのバージョンを返す。	オンラインまたはオフライン
startNodeManager	WLST を実行している同じコンピュータ上のノード マネージャを起動します。	オンラインまたはオフライン

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 プロンプトには wls:/nm/domainName> と表示されます。domainName は管理するドメインの名前を表します。その後で 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 をノード マネージャに接続するオペレータのパスワード。パスワードのデフォルトは weblogic。 注意 : プロダクション モードでサーバを実行している場合は、ノード マネージャに接続するときに適切なユーザ名とパスワードが使用されるように、コマンドラインでユーザ名とパスワードを明示的に指定する必要がある。
host	省略可能。ノード マネージャのホスト名。この引数のデフォルトは localhost。
port	省略可能。ノード マネージャのポート番号。この引数のデフォルトは、ノード マネージャ サーバのタイプに基づいた、以下の値になる。 plain タイプの場合、デフォルトは 5556 rsh タイプの場合、デフォルトは 514 ssh タイプの場合、デフォルトは 22 ssl タイプの場合、デフォルトは 5556
domainName	省略可能。管理するドメインの名前。この引数のデフォルトは mydomain。
domainDir	省略可能。ノード マネージャ秘密ファイル (nm_password.properties) と SerializedSystemIni.dat ファイルを保存するドメイン ディレクトリのパス。この引数のデフォルトは WLST を起動したディレクトリ。
nmType	ノード マネージャ サーバのタイプ。有効な値は以下のとおり。 plain - プレーンなソケットの Java ベースの実装 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:/bea/user_projects/domains/oamdomain','plain') 
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='plain') 
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 の最上位のインストール ディレクトリです。

ドメインが管理サーバとルート ディレクトリを共有している場合を除いて、このコマンドは 1 つのドメイン、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:/bea/mydomain/common/nodemanager') 
Enrolling this machine with the domain directory at c:\bea\mydomain\common\nodemanager....
Successfully enrolled this machine with the domain directory at C:\bea\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:\bea\mydomain\servers\ms1\data\nodemanager\boot.properties
Successfully generated startup.properties at c:\bea\mydomain\servers\ms1\data\nodemanager\startup.properties
wls:/mydomain/serverConfig>

nmKill

コマンド カテゴリ : ノード マネージャ コマンド

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

このコマンドを実行するには、WLST がノード マネージャに接続している必要があります。

説明

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

serverName 引数を使用してサーバ名を指定しない場合、引数はデフォルトで myServer に設定されます。この引数は使用しているサーバ名と一致している必要があり、一致していない場合はコマンドが失敗します。

起動する際にノード マネージャを使用しなかったサーバ インスタンスを強制停止しようとすると、エラーが表示されます。

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

構文

nmKill([serverName])

引数	定義
serverName	省略可能。強制停止するサーバの名前。この引数のデフォルトは myserver。

例

以下の例では、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])

引数	定義
serverName	省略可能。サーバの出力ログを表示するサーバの名前。この引数のデフォルトは myserver。
writer	省略可能。ログ出力を書き込む java.io.Writer オブジェクト。指定しない場合、この引数のデフォルトは WLSTInterpreter 標準出力になる。

例

以下の例では、oamserver サーバのサーバ出力ログを表示して、ログ出力を myWriter に書き込みます。

wls:/nm/oamdomain> nmServerLog('oamserver',myWriter) 
Successfully retrieved the server log and written.
wls:/nm/oamdomain> 

nmServerStatus

コマンド カテゴリ : ノード マネージャ コマンド

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

このコマンドを実行するには、WLST がノード マネージャに接続している必要があります。

説明

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

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

構文

nmServerStatus([serverName])

引数	定義
serverName	省略可能。ステータスを表示するサーバの名前。この引数のデフォルトは myserver。

例

次の例では、ノード マネージャで起動された oamserver というサーバのステータスを表示します。

wls:/nm/oamdomain> nmServerStatus('oamserver') 
RUNNING
wls:/nm/oamdomain>

nmStart

コマンド カテゴリ : ノード マネージャ コマンド

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

このコマンドを実行するには、WLST がノード マネージャに接続している必要があります。

説明

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

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

注意 : boot.properties は、nmStart でサーバを起動するために存在している必要があります。サーバを起動するのが今回が最初である場合、nmStart を使用するために、boot.properties を手動で作成する必要があります。

構文

nmStart([serverName], [domainDir], [props], [writer])

引数	定義
serverName	省略可能。起動するサーバの名前。
domainDir	省略可能。起動するサーバのドメイン ディレクトリ。この引数のデフォルトは、WLST の起動元ディレクトリ。
props	省略可能。新しいサーバに適用するシステム プロパティ。
writer	省略可能。サーバ出力が書き込まれる java.io.Writer オブジェクト。この引数のデフォルトは WLST ライター。

例

以下の例では、ノード マネージャを使用して、現在のドメインで managed1 サーバを起動します。

wls:/nm/mydomain> nmStart("managed1") 
Starting server managed1 ...
Server managed1 started successfully
wls:/nm/mydomain>

以下の例では、ノード マネージャを使用して、指定されたドメインで管理サーバを起動します。この例では、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 インストール ガイド』の「グラフィカル モードでのインストール プログラムの実行」を参照してください。 この場合、ノード マネージャを手動で起動する必要はありません。

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:/bea/wlserver_10.3/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:\bea\wlserver_10.3\common\nodemanager.
wls:/mydomain/serverConfig> 

ツリー コマンド

表 3-13 に示す WLST ツリー コマンドを使用して、MBean 階層内を移動します。

表 3-12 WLST コンフィグレーションのツリー コマンド

コマンド	説明	WLST の使用状況
custom	サーバに登録されているカスタム MBean のルートに移動する。	オンライン
domainConfig	ドメインのコンフィグレーション階層内で最後に移動した MBean、または階層のルートである DomainMBean に移動する。	オンライン
domainCustom	ドメイン実行時 MBean サーバに登録されているカスタム MBean のルートに移動する。	オンライン
domainRuntime	ドメインの実行時階層内で最後に移動した MBean、または階層のルートである DomainRuntimeMBean に移動する。	オンライン
edit	編集コンフィグレーション MBean 階層内で最後に移動した MBean、または階層のルートである DomainMBean に移動する。	オンライン
jndi	WLST が現在接続しているサーバの JNDI ツリーに移動します。	オンライン
serverConfig	コンフィグレーション MBean 階層内で最後に移動した MBean、または階層のルートである DomainMBean に移動する。	オンライン
serverRuntime	実行時 MBean 階層内で最後に移動した MBean、または階層のルートである ServerRuntimeMBean に移動する。	オンライン

custom

コマンド カテゴリ : ツリー コマンド

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

説明

実行時 MBean サーバに登録されているカスタム MBean のルートに移動します。WLST はドメイン MBean と同じようにカスタム MBean への移動、照会、編集を行いますが、カスタム MBean ではスタブを利用できないため cmo 変数は使用できません。

注意 : custom ツリーに移動する場合、WLST は互換性 MBean サーバ、実行時 MBean サーバ、あるいは JVM プラットフォーム MBean サーバにあるすべての MBean に問い合わせて、カスタム MBean を検索します。現在のドメインにある MBean の数によっては、このプロセスに数分かかり、WLST がすぐにプロンプトを返さない場合があります。

custom コマンドは、WLST が管理サーバ インスタンスまたは管理対象サーバ インスタンスに接続しているときに使用できます。WebLogic Integration または WebLogic Portal サーバに接続している場合、WLST はすべての WebLogic Integration または WebLogic Portal サーバ MBean と対話できます。

カスタム MBean の詳細については、『Oracle Fusion Middleware 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 に移動します。この読み込み専用の階層には、現在のドメインを表すコンフィグレーション MBean が格納されています。

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

構文

domainConfig()

例

以下の例では、管理サーバ インスタンス上で、コンフィグレーション MBean 階層からドメインのコンフィグレーション階層に移動します。

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 サーバに登録されているカスタム MBean のドメイン カスタム ツリーに移動します。WLST はドメイン MBean と同じようにドメイン カスタム MBean への移動、照会、編集を行いますが、ドメイン カスタム MBean ではスタブを利用できないため cmo 変数は使用できません。

注意 : domainCustom ツリーに移動する場合、WLST はドメイン実行時 MBean サーバ、各サーバにある実行時 MBean サーバ、あるいは JVM プラットフォーム MBean サーバにあるすべての MBean に問い合わせて、カスタム MBean を検索します。現在のドメインにある MBean の数によっては、このプロセスに数分かかり、WLST がすぐにプロンプトを返さない場合があります。検索の量を制限するために、JMX クエリ オブジェクト名のパターンを指定することをお勧めします。

domainCustom コマンドは、WLST が管理サーバ インスタンスに接続している場合にのみ使用できます。

ドメイン実行時 MBean サーバの詳細については、『Oracle Fusion Middleware Oracle WebLogic Server JMX によるカスタム管理ユーティリティの開発』の「WebLogic Server MBean について」を参照してください。

エラーが発生した場合は、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 に移動します。この読み込み専用の階層には、現在のドメインを表す実行時 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 に移動します。この書き込み可能な階層には、現在のドメインを表すすべてのコンフィグレーション MBean が格納されています。

注意 : コンフィグレーション Bean を編集するには、管理サーバに接続する必要があります。管理対象サーバに接続した場合、WLST の機能はコンフィグレーション Bean 階層の参照だけに制限されます。WLST を使用して管理対象サーバ上の MBean の値を変更することはできませんが、管理 API を使用すれば可能です。ただし、管理サーバ上のコンフィグレーション MBean の値のみを変更することをお勧めします。管理対象サーバ上の MBean の値を変更すると、ドメイン コンフィグレーションに矛盾が生じる可能性があります。 コンフィグレーション Bean の編集に関する詳細については、『Oracle Fusion Middleware 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 Fusion Middleware 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 変数

変数	説明	例
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 が接続しているドメインの名前。	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
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