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

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

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

• 参照コマンド

• 制御コマンド

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

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

• 診断コマンド

• 編集コマンド

• 情報コマンド

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

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

• ツリー・コマンド

• ストア管理コマンド

• WLST変数リファレンス

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

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

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

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

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

参照コマンド

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

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

このコマンドを使用します...	次を行うには...	WLSTの使用...
cd	構成Beanまたは実行時Beanの階層を移動します。	オンラインまたはオフライン
currentTree	階層内の現在の場所を返します。	オンライン
prompt	プロンプトでパス情報の表示を切り替えます。	オンラインまたはオフライン
pwd	階層内の現在の場所を表示します。	オンラインまたはオフライン

cd

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

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

説明

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

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

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

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

構文

cd(mbeanName)

引数	定義
mbeanName	ネーム・スペース内のBeanのパス。

例

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

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

currentTree

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

WLSTでの使用: オンライン

説明

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

構文

currentTree()

例

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

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

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

prompt

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

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

説明

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

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

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

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

構文

prompt(myPrompt)

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

例

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

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

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

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

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

pwd

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

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

説明

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

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

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

構文

pwd()

例

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

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

制御コマンド

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

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

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

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

• ドメイン・テンプレートを記述します(writeTemplateコマンド)

• WLSTを終了します

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

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

このコマンドを使用します...	次を行うには...	WLSTの使用...
addStartupGroup	新しいサーバー起動グループを追加します。	オフライン
addTemplate	アプリケーションまたはサービスの拡張テンプレートを使用して、現在のWebLogicドメインを拡張します。	オフライン
clone	サーバー・オブジェクトのクローンを作成します。	オフライン
closeDomain	現在のドメインを閉じます。	オフライン
closeTemplate	現在のドメイン・テンプレートを閉じます。	オフライン
connect	WLSTをWebLogic Serverインスタンスに接続します。	オンラインまたはオフライン
createDomain	指定されたテンプレートを使用して新しいWebLogicドメインを作成します。	オフライン
deleteStartupGroup	サーバー起動グループを削除します。	オフライン
disconnect	WLSTをWebLogic Serverインスタンスから接続解除します。	オンライン
exit	WLSTを対話セッションから終了させて、スクリプト・シェルを閉じます。	オンラインまたはオフライン
exportPartition	ドメイン・パーティションをパーティション・アーカイブにエクスポートします。	オンライン
getDatabaseDefaults	データベースに接続してスキーマ情報を取得します。	オフライン
getFEHostURL	ドメインのフロントエンド・ホストのプレーンURL、SSL URLまたはデフォルトURLを取得します。	オフライン
getServerGroups	指定されたサーバーがメンバーとなっているサーバー・グループのリストを取得します。	オフライン
getStartupGroup	サーバー起動グループを取得します。	オフライン
getTopologyProfile	ドメインのドメイン・トポロジ・プロファイルを返します。	オフライン
importPartition	パーティション・アーカイブからドメイン・パーティションをインポートします。	オンライン
listServerGroups	ユーザーが展開可能なconfig-groups.xmlサーバー・グループのマップを取得します。	オフライン
loadTemplates	選択テンプレートを使用して、すべての選択されたテンプレートをロードします。	オフライン
readDomain	更新する既存のWebLogicドメインを開きます。	オフライン
readDomainForUpgrade	再構成のために既存のドメインを開きます。	オフライン
readTemplate	ドメインを作成するために既存のドメイン・テンプレートを開きます。	オフライン
readTemplateForUpdate	テンプレートを更新するために既存のドメイン・テンプレートを開きます。	オフライン
rolloutApplications	サービスを中断せずにターゲット・サーバーの指定されたアプリケーションの更新をロールアウトします。	オンライン
rolloutJavaHome	サービスを中断せずに新しいJavaホームをターゲット・サーバーにロールアウトします。	オンライン
rolloutOracleHome	サービスを中断せずにパッチを適用したOracleホームをターゲット・サーバーにロールアウトします。	オンライン
rollingRestart	サービスを中断せずにターゲット・サーバーのローリング再起動を開始します。	オンライン
rolloutUpdate	サービスを中断せずに更新をターゲット・サーバーにロールアウトします。	オンライン
selectCustomTemplate	ドメインを作成するための既存のカスタム・ドメイン・テンプレートまたはアプリケーション・テンプレートを選択します。	オフライン
selectTemplate	ドメインを作成するための既存のドメイン・テンプレートまたはアプリケーション・テンプレートを選択します。	オフライン
setFEHostURL	ドメインのフロントエンド・ホストのプレーンURL、SSL URLおよびデフォルトURLを設定します。	オフライン
setServerGroups	指定されたサーバーのサーバー・グループを設定します。	オフライン
setSharedSecretStoreWithPassword	共有シークレット・ストアおよびパスワードを設定します。	オフライン
setStartupGroup	サーバー起動グループを設定します。	オフライン
setTopologyProfile	ドメイン・トポロジ・プロファイルを設定します。	オフライン
showAvailableTemplates	ロード用のすべての現在選択されているテンプレートを表示します。	オフライン
showTemplates	すべての現在選択されているおよびロードされたテンプレートを表示します。	オフライン
unselectCustomTemplate	選択されたカスタム・ドメイン・テンプレートまたはアプリケーション・テンプレートを選択解除します。	オフライン
unselectTemplate	選択されたドメイン・テンプレートまたはアプリケーション・テンプレートを選択解除します。	オフライン
updateDomain	現在のドメインを更新して保存します。	オフライン
validateConfig	ドメイン構成を検証します。	オフライン
writeDomain	指定されたディレクトリにドメインの構成情報を書き込みます。	オフライン
writeTemplate	指定されたドメイン・テンプレート・ファイルに構成情報を書き込みます。	オンラインおよびオフライン

addStartupGroup

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

WLSTでの使用: オフライン

説明

既存のサーバー・グループに基づいて新しいサーバー起動グループを追加します。サポートされない操作の場合は、WLSTExceptionを返します。

起動グループについては、『ドメイン・テンプレート・リファレンス』のconfig-groups.xmlおよびstartup-plan.xmlに関する項を参照してください。

構文

addStartupGroup(server_startup_group_name, server_group_name)

引数	定義
server_startup_group_name	新しいサーバー起動グループの名前。
server_group_name	ドメイン内の既存のサーバー・グループの名前。

例

次の例では、server_group_1という既存のサーバー・グループから、startup_group_1という起動グループを作成します。

addStartupGroup('startup_group_1', 'server_group_1')

addTemplate

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

WLSTでの使用: オフライン

説明

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

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

構文

addTemplate(templateFileName)

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

例

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

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

注意: addTemplateコマンドはこのリリースで非推奨であり、今後のリリースで削除される予定です。かわりに、selectTemplateおよびloadTemplatesコマンドを使用します。詳細および例は、『WebLogic Scripting Toolの理解』のWebLogicドメインの作成および更新に関する項を参照してください。

closeDomain

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

WLSTでの使用: オフライン

説明

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

構文

closeDomain()

例

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

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

closeTemplate

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

WLSTでの使用: オフライン

説明

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

構文

closeTemplate()

例

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

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

clone

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

WLSTでの使用: オフライン

説明

元のサーバーのクローンを作成します。サポートされない操作の場合は、WLSTExceptionを返します。

構文

clone('originalServerName', 'cloneServerName','type')

引数	定義
originalServerName	クローンを作成するサーバーの名前。
cloneServerName	新しいクローン・サーバーの名前。
type	クローンを作成するオブジェクトのタイプ。現在サポートされている唯一のタイプはServerです。

例

次の例では、server1サーバーのクローンとしてserver1_cloneというサーバーを作成します。

wls:/offline/base_domain>clone('server1','server1_clone','Server')

connect

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

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

説明

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

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

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

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

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

• 管理サーバーのboot.propertiesファイルに格納されている資格証明を使用します。デフォルトでは、管理サーバーを開発モードで作成すると、WebLogic Serverはサーバーの作成に使用された資格証明を暗号化し、暗号化した資格証明をboot.propertiesファイルに格納します。管理サーバーを本番モードで作成すると、boot.propertiesファイルは作成されません。本番ドメインがboot.propertiesファイルを含まない場合、手動で作成できます。『Oracle WebLogic Serverサーバーの起動と停止の管理』の管理サーバーのブート識別ファイルの作成に関する項を参照してください。

  connectコマンドの実行時にドメインの暗号化されたユーザー名とパスワードを含むboot.propertiesファイルが存在する場合、管理サーバーに接続するユーザー名とパスワードを入力する必要はありません。ただし、connectコマンドで管理サーバーの名前を指定する必要があります。

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

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

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

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

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

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

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

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

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

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

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

  • 管理サーバーのlisten-address属性が正しく設定されていることを確認します。たとえば、ドメイン構成ファイル内で、<listen-address>の行を次のようにコメント・アウトします。

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

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

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

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

構文

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

引数	定義
username	オプション。WLSTをサーバーに接続するオペレータのユーザー名。指定しない場合、WLSTはコマンドを上記のように処理します。
password	オプション。WLSTをサーバーに接続するオペレータのパスワード。指定しない場合、WLSTはコマンドを上記のように処理します。
url	オプション。サーバー・インスタンスのリスン・アドレスとリスン・ポート。[protocol://]listen-address:listen-portという形式で指定します。指定しない場合、この引数はデフォルトでt3://localhost:7001になります。
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はコマンドを上記のように処理します。
timeout	オプション。オンライン・コマンドが完了する(返される)のをWLSTが待機するミリ秒数。 WLSTオンライン・コマンドを呼び出すと、WLSTはMBeanサーバーに接続してMBeanサーバー・メソッドを呼び出し、呼出しの結果を返します。MBeanサーバー・メソッドがタイムアウト期間内に返されない場合、WLSTは呼出しを破棄します。この引数には次の構文を使用します: timeout='milliseconds' デフォルト値は0で、操作がタイムアウトしないことを示します。ただし、5分のタイムアウトが異なる層で発生する場合があることに注意してください。
idd	オプション。ユーザーのアイデンティティ・ドメイン。この引数には次の構文を使用します: idd=dbUsers この引数のデフォルトはNoneです。

例

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

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

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 = 'adminusername' 
wls:/offline> password = 'adminpassword' 
wls:/offline> connect(username,password,'t3s://myhost:7001') 
Connecting to weblogic server instance running at t3://myhost:7001 as
username adminusername...

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

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

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

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

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

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

createDomain

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

WLSTでの使用: オフライン

説明

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

注意: createDomainコマンドは、『packおよびunpackコマンドを使用したテンプレートとドメインの作成』で説明されているように、unpackコマンドに類似した機能を備えています。

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

構文

createDomain(domainTemplate, domainDir, user, password, topologyProfile) 

引数	定義
domainTemplate	作成するドメインの基になるドメイン・テンプレートの名前および場所。
domainDir	ドメイン構成情報を書き込むディレクトリの名前。 使用する環境のすべてのドメインをミドルウェア・ホーム・ディレクトリ以外の場所に作成することをお薦めします。これによって、ドメインやアプリケーションを再作成せずに、既存のインストールの削除や新しいバージョンのWebLogic Serverのインストールが簡単にできるようになります。
user	デフォルト・ユーザーの名前。
password	デフォルト・ユーザーのパスワード。
topologyProfile	ドメインのトポロジ・プロファイルとしてCompactまたはExpandedを設定します。『ドメイン・テンプレート・リファレンス』のドメイン・トポロジ・プロファイルに関する項を参照してください。

例

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

wls:/offline> createDomain('c:/Oracle/Middleware/wlserver/common
/templates/wls/wls_medrec.jar','c:/Oracle/Middleware/user_projects/domains/medrec', 
'adminusername','adminpassword')

deleteStartupGroup

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

WLSTでの使用: オフライン

説明

サーバー起動グループを削除します。サポートされない操作の場合は、WLSTExceptionを返します。

構文

deleteStartupGroup('startup_group_name')

引数	定義
startup_group_name	新しいサーバー起動グループの名前。

例

次の例では、サーバー起動グループstartup_group_customを削除します。

wls:/offline/base_domain> deleteStartupGroup('startup_group_custom')

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:\>

exportPartition

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

WLSTでの使用: オンライン

説明

importPartitionコマンドとともに後で使用できるパーティション・アーカイブにパーティションをエクスポートします。パーティションの構成をアーカイブ・ファイルおよび(オプションで)パーティションのアプリケーションとライブラリにコピーします。このコマンドは、インポート時にパーティションの構成を変更するために使用できるattributes.jsonファイルも作成します。

コマンドは非同期であり、ImportExportPartitionTaskMBeanを戻します。

構文

exportPartition(partitionName, expArchPath, [includeAppsNLibs], [keyFile])

引数	定義
partitionName	エクスポートするパーティションの名前。
expArchPath	パーティション・アーカイブを保存するディレクトリへのフルパス。パスは管理サーバーによってアクセス可能である必要があります。アーカイブ・ファイルはPartitionName.zipという名前になります。
includeAppsNLibs	オプション。trueを指定すると、パーティション・アーカイブにアプリケーションとライブラリのバイナリが含まれます。falseを指定すると含まれません。デフォルトはtrueです。
keyfile	オプション。パーティション・アーカイブ内の属性を暗号化するための暗号化鍵として使用する文字列を含むファイルへのフルパス。パスは管理サーバーによってアクセス可能である必要があります。この引数のデフォルトは内部キーを使用します。

例

次の例では、partition1を/var/tmpディレクトリにエクスポートします。アプリケーションおよびライブラリのバイナリは含まれません。ファイル/home/foo/mykeyfileは暗号化鍵として使用されます。

wls:/mydomain/serverConfig> task = exportPartition("partition1", "/var/tmp/", false, "/home/foo/mykeyfile")

getDatabaseDefaults

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

WLSTでの使用: オフライン

説明

LocalSvcTblDataSourceをデータベース・サーバーに接続し、スキーマ情報を取得して、取得したパラメータを自動的にローカル・スキーマ・コンポーネントにバインドします。getDatabaseDefaults()を呼び出す前に、データ・ソースLocalSvcTblDataSourceに必要な接続パラメータを構成しておく必要があります。

注意: このコマンドは、作成または変更しているドメインに、Oracle Fusion Middlewareリポジトリ作成ユーティリティ(RCU)を使用してデータベース・スキーマをロードする必要のあるFusion Middlewareコンポーネントが含まれている場合にのみ使用できます。LocalSvcTblDataSourceは、RCUのServiceTableコンポーネントに対応するスキーマに接続します。 getDatabaseDefaults()では、RCUを使用してスキーマを最初に作成したときに設定したスキーマ・パスワードが取得されます。RCUを実行してからドメインを作成するまでの間にスキーマ・パスワードが変更された場合は、WLSTスクリプトでgetDatabaseDefaults()を呼び出した後、writeDomain()を呼び出す前にパスワードを再度指定する必要があります。例: getDatabaseDefaults() cd('/JDBCSystemResource/LocalSvcTblDataSource/JdbcResource/ LocalSvcTblDataSource/JDBCDriverParams/NO_NAME_0') set('PasswordEncrypted', 'new_password') writeDomain(DOMAIN_HOME)

構文

getDatabaseDefaults()

例

次の例では、fmwdomainというドメインのスキーマ情報を取得します。

wls:/offline/fmwdomain>cd('JDBCSystemResource/LocalSvcTblDataSource/JdbcResource/LocalSvcTblDataSource')
wls:/offline/fmwdomain>cd('JDBCDriverParams/NO_NAME_0')
wls:/offline/fmwdomain>set('DriverName','oracle.jdbc.OracleDriver')
wls:/offline/fmwdomain>set('URL','jdbc:oracle:thin:@localhost:1522/xe')
wls:/offline/fmwdomain>set('PasswordEncrypted', 'password')
wls:/offline/fmwdomain>cd('Properties/NO_NAME_0')
wls:/offline/fmwdomain>cd('Property/user')
wls:/offline/fmwdomain>cmo.setValue('DEV_STB')
wls:/offline/fmwdomain>getDatabaseDefaults()

getFEHostURL

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

WLSTでの使用: オフライン

説明

ドメインのフロントエンド・ホストのプレーンURL、SSL URLまたはデフォルトURLをサービス表から取得します。

構文

getFEHostURL(type)

引数	定義
type	次のいずれかのタイプを指定します。defaultを指定すると、フロントエンド・ホストのURLの設定時にどちらをデフォルトとして設定したかに応じて、プレーンURLまたはSSL URLが返されます。 plain ssl default

例

次の例では、ドメインmydomainのフロントエンド・ホストのSSL URLを返します。

wls:/offline> readDomain("/domains/mydomain")
wls:/offline> getFEHostURL("ssl")
wls:/offline> https://myhost.com:7070

getServerGroups

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

WLSTでの使用: オフライン

説明

指定されたサーバーがメンバーとなっているサーバー・グループのリストを取得します。サポートされない操作の場合は、WLSTExceptionを返します。

構文

getServerGroups(server_name)

引数	定義
server_name	サーバーの名前。この名前に関連付けられたサーバー・グループ(存在する場合)が返されます。

例

次の例では、サーバーmy_serverのサーバー・グループを取得します。

wls:/offline/base_domain> getServerGroups('my_server')
'["SERVER-GROUP1-NAME", "SERVER-GROUP2-NAME"]'

getStartupGroup

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

WLSTでの使用: オフライン

説明

サーバーに関連付けられたサーバー起動グループを取得します。サポートされない操作の場合は、WLSTExceptionを返します。

構文

getStartupGroups(server_name)

引数	定義
server_name	サーバーの名前。この名前に対するサーバー起動グループが存在する場合は、それが返されます。

例

次の例では、サーバーmy_serverのサーバー起動グループを取得します。

wls:/offline/base_domain> getStartupGroup('my_server')
'Startup_Group_1'

getTopologyProfile

ドメインのドメイン・トポロジ・プロファイルを返します。

構文

getTopologyProfile()

例

次の例では、ドメインmydomainを読み取って、ドメインのトポロジ・プロファイル(CompactまたはExpanded)を取得します。

wls:/offline> readDomain('C:/domains/mydomain')
wls:/mydomain> getTopologyProfile()
'Expanded'
wls:/mydomain>

importPartition

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

WLSTでの使用: オンライン

説明

パーティション・アーカイブ(exportPartitionコマンドによって生成されます)をドメインにインポートします。インポート時にパーティションの構成を変更するために使用できるattributes.jsonファイルをサポートします。

コマンドは非同期であり、ImportExportPartitionTaskMBeanを戻します。

構文

importPartition(archiveFileName, [partitionName], [createNew], [keyFile])

引数	定義
archiveFileName	インポートするパーティション・アーカイブのフルパス。パスは管理サーバーによってアクセス可能である必要があります。importPartitionは、パーティション・アーカイブと同じディレクトリのPartitionName-attributes.jsonファイルも検索します。検出された場合、そのファイルの値はパーティション・アーカイブの値をオーバーライドします。
partitionName	オプション。新規ドメインに作成されるときにパーティションに使用する名前。デフォルトはそのパーティションの元の名前です。
createNew	オプション。リソース・グループ・テンプレートの競合の処理方法を制御します。パーティションで使用されるすべてのリソース・グループ・テンプレートはパーティション・アーカイブに含まれ、パーティションとともにドメインにインポートされます。 リソース・グループ・テンプレートがすでにドメインに存在し、この引数がfalseである場合、既存のリソース・グループ・テンプレートが使用されます。この引数がtrueである場合、新規リソース・グループ・テンプレートが新しい名前で作成されます。このフラグが指定されないと、リソース・グループ・テンプレートがドメインにすでに存在する場合にインポートが失敗します。
keyfile	オプション。パーティション・アーカイブ内の属性を復号化するための暗号化鍵として使用する文字列を含むファイルへのフルパスパスは管理サーバーによってアクセス可能である必要があります。この引数のデフォルトは内部キーを使用します。

例

次の例では、/var/tmpディレクトリにあるpartition1アーカイブをインポートします。アプリケーションおよびライブラリのバイナリは含まれません。ファイル/home/foo/mykeyfileは暗号化鍵として使用されます。

wls:/mydomain/serverConfig> importPartition("/var/tmp/partition1.zip", keyFile="/home/foo/mykeyfile")

listServerGroups

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

WLSTでの使用: オフライン

説明

ユーザーが展開可能なconfig-groups.xmlサーバー・グループのマップを取得します。サポートされない操作の場合は、WLSTExceptionを返します。

サーバー・グループについては、『ドメイン・テンプレート・リファレンス』のconfig-groups.xmlおよびstartup-plan.xmlに関する項を参照してください。

構文

listServerGroups([printout])

引数	定義
printout	オプション。false(デフォルト)の場合、出力は、Jythonディクショナリ・タイプ(サーバー・グループ名をキーとして使用し、サーバー・グループ説明を値として使用する)で返されるサーバー・グループ名で、プログラムで使用される形式にフォーマットされます。trueの場合、出力はユーザーが読み取りやすい表にフォーマットされます。この表には、サーバー・グループ名の列と、そのサーバー・グループに対応する説明の列が含まれます。

例

次の例では、サーバー・グループを、プログラムで使用される形式で出力します。

wls:/offline> listServerGroups()
'{"SERVER-GROUP1-NAME" : "Server Group 1 Description", "SERVER-GROUP2-NAME" : "Server Group 2 Description"}'
wls:/offline>

次の例では、サーバー・グループを、プログラムで使用される形式で出力します。

wls:/offline> print listServerGroups('true')
Server Group       | Description
-------------------|---------------------------
SERVER-GROUP1-NAME | Server Group 1 Description
SERVER-GROUP2-NAME | Server Group 2 Description
wls:/offline>

readDomain

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

WLSTでの使用: オフライン

説明

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

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

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

wls:/offline/base_domain>

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

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

構文

readDomain(domainDirName)

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

例

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

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

readDomainForUpgrade

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

WLSTでの使用: オフライン

説明

readDomainForUpgrade()関数は、次の3つの基本タスクを実行します。

• WebLogic Serverのコア構成を新しいバージョンにアップグレードします。

• 既存のreadDomain関数と同様に、結果のドメインをメモリーに読み込みます。

• 既存のaddTemplate関数と同様に、必要な再構成テンプレートを選択してドメインに追加します。

この操作でコアWebLogic Serverのアップグレード部分が成功した場合、元に戻すことはできません。再構成テンプレートの追加後は、追加を有効にするために、セッション内でupdateDomain関数を使用してコミットする必要があります。

構文

readDomainForUpgrade(domain_dir), [properties]

引数	定義
domain_dir	構成を行うために開くドメイン・ディレクトリのパス。
properties	オプション。WebLogic Serverコア・インフラストラクチャのアップグレード用の、WebLogic Serverで定義されたプロパティ。これには、java.util.Propertiesオブジェクト、Python Directoryオブジェクト、またはセミコロンで区切られたname=valueペアの文字列を指定できます。

例

次の例では、C:\domains\medrecにあるドメインをアップグレードのために開きます。

>wls:/offline> readDomainForUpgrade('c:/domains/medrec')

readTemplate

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

WLSTでの使用: オフライン

説明

ドメインを作成するために既存のドメイン・テンプレートを開き、オプションで、使用するconfig-groupsのトポロジを指定します(WebLogic Serverの完全インストール時のみ)。

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

wls:/offline/base_domain>

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

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

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

構文

readTemplate(templateFileName), [topologyprofile]

引数	定義
templateFileName	ドメイン・テンプレートに相当するJARファイルの名前。
topologyprofile	オプション。使用するconfig-groupsのトポロジ・プロファイル(CompactまたはExpanded)。この引数は、WebLogic Serverの完全インストールでのみ使用可能で、テンプレートにこれらのトポロジが定義されている場合にのみ適用されます。省略した場合は、Expandedトポロジが使用されます。 注意: この引数は、スタンドアロンでインストールされたシステム・コンポーネント(OHSなど)には適用されません。このようなスタンドアロンのインストールには、制限付きのWLSTツールが用意されています。

例

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

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

注意: readTemplateコマンドはこのリリースで非推奨であり、今後のリリースで削除される予定です。かわりに、selectTemplateおよびloadTemplatesコマンドを使用します。詳細および例は、『WebLogic Scripting Toolの理解』のWebLogicドメインの作成および更新に関する項を参照してください。

setFEHostURL

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

WLSTでの使用: オフライン

説明

ドメインのフロントエンド・ホストのプレーンURLおよびSSL URLを設定し、プレーンURLとSSL URLのどちらがデフォルトかを指定します。

構文

setFEHostURL(plain, ssl, isDefaultPlain)

引数	定義
plain	フロントエンド・ホストのプレーンURLを次の形式で設定します。 http://host:port
ssl	フロントエンド・ホストのSSL URLを次の形式で設定します。 https://host:port 注意: フロントエンド・ホストのプレーンURLを使用している場合は引き続きデフォルトのSSL URLを指定する必要があります。フロントエンド・ホストにプレーン接続のみを設定している場合、プレーンとSSLに同じURLを使用できます。それ以外の場合は、異なる必要があります。
isPlainDefault	ブール値。trueに設定すると、プレーンURLがフロントエンド・ホストのデフォルトになります。falseに設定すると、SSL URLがフロントエンド・ホストのデフォルトになります。

例

次の例では、ドメインmydomainのフロントエンド・ホストのプレーンURLおよびSSL URLを設定し、デフォルトがSSL URLであることを指定します。

wls:/offline> readDomain("/domains/mydomain")
wls:/offline> setFEHostURL("http://www.myhost.com:7733","http://www.myhost.com:7733"4455", 
false)

setServerGroups

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

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

説明

指定したサーバーの所属先となる、ユーザーが展開可能なサーバー・グループを設定します。この関数の実行後、サーバーは指定されたサーバー・グループにのみ属するようになります。

サポートされない操作の場合は、WLSTExceptionを返します。

構文

setServerGroups(serverName, serverGroups, [timeout], [skipEdit])

引数	定義
serverName	ユーザーが構成可能な指定されたサーバー・グループに関連付けるサーバー名。
serverGroups	指定されたサーバーに関連付ける、ユーザーが構成可能なサーバー・グループのPythonリスト。
timeout	オプション。オンライン・モードでsetServerGroupsを使用している場合にのみ適用されます。接続タイムアウトになるまでに接続が非アクティブの状態を維持できる時間を指定します。デフォルトは、120000ミリ秒です。
skipEdit	オプション。オンライン・モードでsetServerGroupsを使用している場合にのみ適用されます。trueに設定した場合、setServerGroupsのオンライン操作では新しいWLST edit()セッションの開始とアクティブ化は行われず、既存のedit()セッションが使用されます。デフォルトはfalseです。

例

次の例では、サーバーmy_serverを、ユーザーが展開可能なサーバー・グループであるserver_group_1およびserver_group_2に関連付けます。

wls:/offline/base_domain> groups="server_group_1, server_group_2"
wls:/offline/base_domain> setServerGroups('my_server', groups)

setStartupGroup

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

WLSTでの使用: オフライン

説明

サーバーにサーバー起動グループを設定します。サポートされない操作の場合は、WLSTExceptionを返します。

構文

setStartupGroup(server_name, server_startup_group_name)

引数	定義
server_name	起動グループを設定するサーバーの名前。
server_startup_group_name	ドメイン内の既存のサーバー起動グループの名前。

例

次の例では、サーバーmy_serverの起動グループをstartup_group_1に設定します。

wls:/offline/base_domain> setStartupGroup('my_server', 'startup_group_1')

setSharedSecretStoreWithPassword

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

WLSTでの使用: オフライン

説明

Fusion Middleware製品を含むドメインの共有データベースに、共有シークレット・ストアおよびパスワードを設定します。サポートされない操作の場合は、WLSTExceptionを返します。

共有データベースの使用については、『Oracle Platform Security Servicesによるアプリケーションの保護』のデータベース・インスタンスの共有に関する項を参照してください。

構文

setSharedSecretStoreWithPassword(sharedSecretStore, secretStorePassword)

引数	定義
sharedSecretStore	共有シークレット・ストアの名前。
secretStorePassword	共有シークレット・ストアのパスワード。

例

次の例では、ドメインbase_domainのシークレット・ストアstore1のパスワードをpasswordに設定します。

wls:/offline/base_domain>setSharedSecretStoreWithPassword(store1, password)

updateDomain

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

WLSTでの使用: オフライン

説明

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

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

構文

updateDomain()

例

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

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

writeDomain

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

WLSTでの使用: オフライン

説明

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

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

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

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

注意: WebLogicドメインの名前はドメイン・ディレクトリの名前から取られます。たとえば、ドメインがc:/Oracle/Middleware/user_projects/domains/myMedrecに保存される場合、ドメイン名はmyMedrecになります。 既存のドメインを更新する場合は、writeDomain()のかわりにupdateDomainを使用する必要があります。

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

cd('/Security/base_domain/User/adminusername')
cmo.setPassword('adminpassword')

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

構文

writeDomain(domainDir)

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

例

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

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

writeTemplate

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

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

説明

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

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

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

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

構文

writeTemplate(templateName, [timeout])

引数	定義
templateName	ドメイン構成情報を格納するドメイン・テンプレートの名前。
timeout	オプション。オンライン・モードでwriteTemplateを使用している場合にのみ適用されます。接続タイムアウトになるまでにリモート・サーバーとの接続が非アクティブの状態を維持できる時間を指定します。

例

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

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

validateConfig

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

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

説明

指定したオプションを使用して、ドメイン構成を検証します。検証エラーが発生した場合は、WLSTExceptionが返されます。

構文

validateConfig(option)

引数

定義

option

次のオプションのいずれかを指定します。 InternalPortConflict - 現在のドメイン構成における管理サーバーおよび管理対象サーバーのリスニング・ポートの競合を検証します。 ExternalPortConflict - 現在のマシン(ホスト)上のアクティブ・プロセスで使用中のポートに対する、管理サーバーおよび管理対象サーバーのリスニング・ポートの競合を検証します。 KeyStorePasswords - 有効なメタデータを含む選択されたテンプレートに、それ用に作成された資格証明ストアがないかどうか確認します。 ClusterFrontEnd - 構成済フロントエンド・ホストおよびフロントエンドhttp (またはhttps)の値の形式を検証します。フロントエンド・ホストの設定時にフロントエンドhttp (またはhttps)の値が欠落していないか、あるいはフロントエンドhttp (またはhttps)の値の設定時にフロントエンド・ホストの値が欠落していないかも検証します。

例

次の例では、ドメインbase_domainの内部リスニング・ポートの構成が検証されます。

wlst:/offline/base_domain>validateConfig('InternalPortConflict')

setTopologyProfile

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

WLSTでの使用: オフライン

説明

そのドメインに使用するドメイン・トポロジ・プロファイル(CompactまたはExpanded)を指定します。ドメイン・テンプレートを選択する前に、これを設定する必要があります。トポロジ・プロファイルが設定されていない場合、デフォルトのトポロジが使用されます。

構文

setTopologyProfile(Topology Profile)

引数	定義
Topology Profile	使用するconfig-groupsのトポロジ・プロファイル(CompactまたはExpanded)。トポロジ・プロファイルが設定されていない場合、Expandedトポロジが使用されます。

例

次の例では、ドメインに対してCompactとしてドメイン・トポロジ・プロファイルを設定します。

wlst:/offline> setTopologyProfile('Compact')

selectTemplate

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

WLSTでの使用: オフライン

説明

ドメインを作成するための既存のドメイン・テンプレートまたはアプリケーション・テンプレートを選択します。

構文

selectTemplate(Template Name,Template Version)

引数	定義
Template Name	テンプレート・ディスクリプタ・ファイルで定義されているドメイン・テンプレートの名前。
Template Version	オプション。ドメイン・テンプレートのバージョン。同じ名前を使用した複数のテンプレートがある場合、テンプレート・バージョンを指定する必要があります。ミドルウェア・ホームに同じ名前を使用した複数のテンプレートがある場合、テンプレート・バージョンを指定しないとエラーが発生します。

例

次の例では、ドメインを作成するために指定されたドメイン・テンプレートを選択します。

wls:/offline> selectTemplate('Basic WebLogic Server Domain','12.2.1.0')

rolloutApplications

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

WLSTでの使用: オンライン

説明

サービスを中断せずにターゲット・サーバーにデプロイされている指定されたアプリケーションに更新をロールアウトします。ターゲットは、ドメイン、クラスタまたはサーバーのカンマ区切りリストのいずれかになります。

この操作には、サーバーの正常な停止、アプリケーションの更新、ノード・マネージャの再起動およびサーバーの再起動が含まれます。

構文

rolloutApplications(target, applicationPropertiesFile, [options])

引数	定義
target	ロールアウトが有効になるドメイン、クラスタまたはカンマ区切りリストのサーバーの名前。
applicationPropertiesFile	更新される各アプリケーションのプロパティを含むテキスト・ファイルの場所。
options	オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: isDryRun—ブール値。trueに設定されている場合、操作は評価されますが、実行されません。このオプションのデフォルトはfalseです。 autoRevertOnFailure—ブール値。trueに設定されている場合、操作が失敗時に自動的に元に戻ります。falseに設定されている場合、操作は失敗時に停止し、ユーザーが操作を再開するまで待機します。このオプションのデフォルトはtrueです。 isSessionCompatible—ブール値。Oracleホームのパッチ適用済バージョンとパッチ未適用バージョンの各セッションに互換性がある場合、trueに設定します。これは、セッション処理時間および正常なサーバー停止時間に影響します。パッチ未適用のセッションを保持するために特別な配慮が必要な場合、falseに設定します。これはロールアウトが完了するまでの時間に影響する可能性があります。このオプションのデフォルトはfalseです。 migrationProperties—ロールアウト中に実行するシングルトン・サービス移行を定義するJSONファイルへのフルパス。このファイルおよびサービス移行の詳細は、『ゼロ・ダウンタイム・パッチ適用ワークフローの管理』のシングルトン・サービスの移行の準備に関する項を参照してください。 shutdownTimeout—WLSTがサーバーを強制的に停止する前に正常に停止するまでに待機する時間(秒)。パッチ適用済のセッションがパッチ未適用のセッションと互換性がない場合、最後のノードのサーバーの強制的な停止によってセッション・データが失われる可能性があります。 1未満の値は無視されます。

例

次の例では、rolloutApplicationsコマンドを使用してJSON形式アプリケーションのプロパティ・ファイル/u01/scratch/app_update.jsonで定義されているアプリケーションをCluster1のすべてのサーバーにロールアウトする方法を示します。

wls:/myDomain/serverConfig/> progress=rolloutApplications('Cluster1', '/u01/scratch/app_update.json')

rolloutJavaHome

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

WLSTでの使用: オンライン

説明

サービスを中断せずに新しいJavaHomeを使用するためにターゲット・サーバーを更新します。

この操作により、ユーザーのサービスを中断せずにサーバーの正常な停止、Javaホームの場所の更新、ノード・マネージャの再起動およびサーバーの再起動が実行されます。

構文

rolloutJavaHome(target, javaHomeDirectory, [options])

引数	定義
target	ロールアウトが有効になるドメイン、クラスタまたはカンマ区切りリストのサーバーの名前。
javaHomeDirectory	使用する新しいJavaホームの場所。これは、各マシンにインストールされている有効なJavaホーム・パスを参照する必要があります。
options	オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: isDryRun—ブール値。trueに設定されている場合、操作は評価されますが、実行されません。このオプションのデフォルトはfalseです。 autoRevertOnFailure—ブール値。trueに設定されている場合、操作が失敗時に自動的に元に戻ります。falseに設定されている場合、操作は失敗時に停止し、ユーザーが操作を再開するまで待機します。このオプションのデフォルトはtrueです。 isSessionCompatible—ブール値。Oracleホームのパッチ適用済バージョンとパッチ未適用バージョンの各セッションに互換性がある場合、trueに設定します。これは、セッション処理時間および正常なサーバー停止時間に影響します。パッチ未適用のセッションを保持するために特別な配慮が必要な場合、falseに設定します。これはロールアウトが完了するまでの時間に影響する可能性があります。このオプションのデフォルトはfalseです。 migrationProperties—ロールアウト中に実行するシングルトン・サービス移行を定義するJSONファイルへのフルパス。このファイルおよびサービス移行の詳細は、『ゼロ・ダウンタイム・パッチ適用ワークフローの管理』のシングルトン・サービスの移行の準備に関する項を参照してください。 shutdownTimeout—WLSTがサーバーを強制的に停止する前に正常に停止するまでに待機する時間(秒)。パッチ適用済のセッションがパッチ未適用のセッションと互換性がない場合、最後のノードのサーバーの強制的な停止によってセッション・データが失われる可能性があります。 1未満の値は無視されます。

例

次の例では、rolloutJavaHomeコマンドを使用して新しいJavaホームをクラスタCluster1にロールアウトする方法を示します。新しいJavaホームの場所は、/u01/jdk1.8.0_50です。

wls:/myDomain/serverConfig/> progress=rolloutJavaHome('Cluster1', '/u01/jdk1.8.0_50') 

rolloutOracleHome

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

WLSTでの使用: オンライン

説明

パッチ適用済のOracleホームをターゲット・サーバーにロールアウトするか、ターゲット・サーバーを以前のパッチ未適用のOracleホームに戻して使用します。

この操作により、ユーザーのサービスを中断せずにサーバーの正常な停止、ノード・マネージャの再起動およびサーバーの再起動が実行されます。

構文

rolloutOracleHome(target, rolloutOracleHome, backupOracleHome, isRollout, [options])

引数	定義
target	ロールアウトが有効になるドメイン、クラスタまたはカンマ区切りリストのサーバーの名前。
rolloutOracleHome	既存のOracleホームを置き換える、ロールアウトするOracleホームのバージョンを含むアーカイブまたはローカル・ディレクトリの場所。
backupOracleHome	既存のOracleホームを移動するローカル・ディレクトリのパス。
isRollout	ブール値。ユーザーがドメインにロールアウトする変更を以前のパッチ・リリースのOracleホームに指定することを許可します。この情報は、管理サーバーを最初または最後に更新する必要があるかどうかを決定する場合に重要です。 ロールアウトするOracleホームが現在のOracleホームより古いパッチ・バージョンを含む場合、Trueに設定します。
options	オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: isDryRun—ブール値。trueに設定されている場合、操作は評価されますが、実行されません。このオプションのデフォルトはfalseです。 autoRevertOnFailure—ブール値。trueに設定されている場合、操作が失敗時に自動的に元に戻ります。falseに設定されている場合、操作は失敗時に停止し、ユーザーが操作を再開するまで待機します。このオプションのデフォルトはtrueです。 isSessionCompatible—ブール値。Oracleホームのパッチ適用済バージョンとパッチ未適用バージョンの各セッションに互換性がある場合、trueに設定します。これは、セッション処理時間および正常なサーバー停止時間に影響します。パッチ未適用のセッションを保持するために特別な配慮が必要な場合、falseに設定します。これはロールアウトが完了するまでの時間に影響する可能性があります。このオプションのデフォルトはfalseです。 migrationProperties—ロールアウト中に実行するシングルトン・サービス移行を定義するJSONファイルへのフルパス。このファイルおよびサービス移行の詳細は、『ゼロ・ダウンタイム・パッチ適用ワークフローの管理』のシングルトン・サービスの移行の準備に関する項を参照してください。 shutdownTimeout—WLSTがサーバーを強制的に停止する前に正常に停止するまでに待機する時間(秒)。パッチ適用済のセッションがパッチ未適用のセッションと互換性がない場合、最後のノードのサーバーの強制的な停止によってセッション・データが失われる可能性があります。 1未満の値は無視されます。

例

次の例では、rolloutOracleHomeコマンドを使用して新しいOracleホームをドメインmyDomainにロールアウトする方法を示します。パッチ適用済のOracleホームのJARファイルは、/net/wls/wls_patched.jarにあります。元のOracleホームは、/u01/Oracle_Home_backupに移動されます。失敗した場合、プロセスは自動的に元に戻りません。

wls:/myDomain/serverConfig/> progress=rolloutOracleHome('myDomain', '/net/wls/wls_patched.jar', '/u01/Oracle_Home_backup', autoRevertOnFailure=FALSE)
)

rollingRestart

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

WLSTでの使用: オンライン

説明

サービスを中断せずにドメイン内のすべてのサーバーまたは特定のクラスタ内のすべてのサーバーのローリング再起動を示します。このコマンドは、サーバーを順番に再起動する機能を提供します。

この操作には、ユーザーのサービスを中断せずにサーバーの正常な停止およびサーバーの再起動が含まれます。

構文

rollingRestart(target, [options])

引数	定義
target	ロールアウトが有効になるドメイン、クラスタまたはカンマ区切りリストのサーバーの名前。
options	オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: isDryRun—ブール値。trueに設定されている場合、操作は評価されますが、実行されません。このオプションのデフォルトはfalseです。 autoRevertOnFailure—ブール値。trueに設定されている場合、操作が失敗時に自動的に元に戻ります。falseに設定されている場合、操作は失敗時に停止し、ユーザーが操作を再開するまで待機します。このオプションのデフォルトはtrueです。 isSessionCompatible—ブール値。Oracleホームのパッチ適用済バージョンとパッチ未適用バージョンの各セッションに互換性がある場合、trueに設定します。これは、セッション処理時間および正常なサーバー停止時間に影響します。パッチ未適用のセッションを保持するために特別な配慮が必要な場合、falseに設定します。これはロールアウトが完了するまでの時間に影響する可能性があります。このオプションのデフォルトはfalseです。 migrationProperties—ロールアウト中に実行するシングルトン・サービス移行を定義するJSONファイルへのフルパス。このファイルおよびサービス移行の詳細は、『ゼロ・ダウンタイム・パッチ適用ワークフローの管理』のシングルトン・サービスの移行の準備に関する項を参照してください。 shutdownTimeout—WLSTがサーバーを強制的に停止する前に正常に停止するまでに待機する時間(秒)。パッチ適用済のセッションがパッチ未適用のセッションと互換性がない場合、最後のノードのサーバーの強制的な停止によってセッション・データが失われる可能性があります。 1未満の値は無視されます。

例

次の例では、一度に1つずつ、rollingRestartコマンドを使用してドメインmyDomain内のすべてのサーバーを再起動します。次に、戻された進行状況オブジェクトを使用して操作の進行状況および状態を表示します。

wls:/myDomain/serverConfig/> progress = rollingRestart('myDomain')
 wls:/myDomain/serverConfig/> progress.getProgressString()
    '[MgmtOrchestration:2192004]Workflow wf9 Running: 43 / 80'
 wls:/myDomain/serverConfig/> progress.getStatus()    'SUCCESS'

rolloutUpdate

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

WLSTでの使用: オンライン

説明

サービスを中断せずまたはセッションを失わずにOracleホーム、Javaホームまたはサーバーにデプロイされたアプリケーションを使用するためにターゲット・サーバーを更新します。このコマンドは、指定されるオプション・パラメータに応じて、それらの更新の組合せを許可します。ユーザーがOracleホーム、Javaホームまたはアプリケーション・プロパティ・パラメータを指定しない場合、rollingRestartが実行されます。

構文

rolloutUpdate(target, [rolloutOracleHome, backupOracleHome, isRollout], [javaHomeDirectory], [applicationPropertiesFile], [options])

引数	定義
target	ロールアウトが有効になるドメイン、クラスタまたはカンマ区切りリストのサーバーの名前。
rolloutOracleHome	オプション。ユーザーがOracleホームを更新する場合、この引数を指定する必要があります。 この引数の詳細は、rolloutOracleHomeの引数の説明を参照してください。
backupOracleHome	オプション。ユーザーがOracleホームを更新する場合、この引数を指定する必要があります。 この引数の詳細は、rolloutOracleHomeの引数の説明を参照してください。
isRollout	オプション。ユーザーがOracleホームを更新する場合、この引数を指定する必要があります。 この引数の詳細は、rolloutOracleHomeの引数の説明を参照してください。
javaHomeDirectory	オプション。ユーザーがJavaホームを更新する場合、この引数を指定する必要があります。 この引数の詳細は、rolloutJavaHomeの引数の説明を参照してください。
applicationPropertiesFile	オプション。ユーザーがサーバーにデプロイされたアプリケーションを更新する場合、この引数を指定する必要があります。 この引数の詳細は、rolloutApplicationsの引数の説明を参照してください。
options	オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: iDryRun—ブール値。trueに設定されている場合、操作は評価されますが、実行されません。このオプションのデフォルトはfalseです。 ユーザーがOracleホーム、Javaホームまたはサーバーにデプロイされたアプリケーションを更新する場合、この引数を指定できます。 autoRevertOnFailure—ブール値。trueに設定されている場合、操作が失敗時に自動的に元に戻ります。falseに設定されている場合、操作は失敗時に停止し、ユーザーが操作を再開するまで待機します。このオプションのデフォルトはtrueです。 ユーザーがOracleホーム、Javaホームまたはサーバーにデプロイされたアプリケーションを更新する場合、この引数を指定できます。 isSessionCompatible—ブール値。Oracleホームのパッチ適用済バージョンとパッチ未適用バージョンの各セッションに互換性がある場合、trueに設定します。これは、セッション処理時間および正常なサーバー停止時間に影響します。パッチ未適用のセッションを保持するために特別な配慮が必要な場合、falseに設定します。これはロールアウトが完了するまでの時間に影響する可能性があります。このオプションのデフォルトはfalseです。 ユーザーがOracleホームまたはサーバーにデプロイされたアプリケーションを更新する場合のみ、この引数を指定できます。 migrationProperties—ロールアウト中に実行するシングルトン・サービス移行を定義するJSONファイルへのフルパス。このファイルおよびサービス移行の詳細は、『ゼロ・ダウンタイム・パッチ適用ワークフローの管理』のシングルトン・サービスの移行の準備に関する項を参照してください。 shutdownTimeout—WLSTがサーバーを強制的に停止する前に正常に停止するまでに待機する時間(秒)。パッチ適用済のセッションがパッチ未適用のセッションと互換性がない場合、最後のノードのサーバーの強制的な停止によってセッション・データが失われる可能性があります。 1未満の値は無視されます。

例

次の例では、rolloutUpdateコマンドを使用して新しいOracleホームおよび新しいJavaホームを管理サーバーにロールアウトします。パッチ適用済のOracleホームのJARファイルは、/net/wls/wls_patched.jarにあります。元のOracleホームは、/u01/Oracle_Home_backupに移動されます。新しいJavaホームの場所は、/u01/jdk1.8.0_50です。

wls:/myDomain/serverConfig/> progress=rolloutUpdate('AdminServer', '/net/wls/wls_patched.jar', '/u01/Oracle_Home_backup', '/u01/jdk1.8.0_50')

selectCustomTemplate

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

WLSTでの使用: オフライン

説明

ドメインを作成するための既存のカスタム・ドメイン・テンプレートまたはアプリケーション・テンプレートを選択します。

構文

selectCustomTemplate(Template Path)

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

例

次の例では、ドメインを作成するwls.jarカスタム・ドメイン・テンプレートを選択します。

wls:/offline> selectCustomTemplate('C:/Oracle/Middleware/WLS/wlserver/common/templates/wls/wls.jar')

unselectTemplate

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

WLSTでの使用: オフライン

説明

ドメイン作成の処理中に選択されたドメイン・テンプレートまたはアプリケーション・テンプレートを選択解除します。

構文

unselectTemplate(Template Name, Template Version)

引数	定義
Template Name	テンプレート・ディスクリプタ・ファイルで定義されているドメイン・テンプレートの名前。
Template Version	オプション。選択解除するドメイン・テンプレートのバージョン。同じ名前を使用した複数のテンプレートがある場合、テンプレート・バージョンを指定する必要があります。

例

次の例では、ドメイン作成の処理中に指定されたドメイン・テンプレートを選択解除します。

wls:/offline> unselectTemplate('Basic WebLogic Server Domain','12.2.1.0')

unselectCustomTemplate

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

WLSTでの使用: オフライン

説明

、ドメイン作成の処理中に選択されたカスタム・ドメイン・テンプレートまたはアプリケーション・テンプレートを選択解除します。

構文

unselectCustomTemplate(Template Path)

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

例

次の例では、ドメイン作成の処理中にwls.jarカスタム・ドメイン・テンプレートを選択解除します。

wls:/offline> unselectCustomTemplate('C:/Oracle/Middleware/WLS/wlserver/common/templates/wls/wls.jar')

loadTemplates

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

WLSTでの使用: オフライン

説明

selectTemplateコマンドを使用して、すべての選択されたテンプレートをロードします。

構文

loadTemplates()

例

次の例では、選択されたテンプレートをロードします。

wls:/offline> loadTemplates()

readTemplateForUpdate

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

WLSTでの使用: オフライン

説明

テンプレートを更新するために既存のドメイン・テンプレートを開きます。ドメイン・テンプレートを更新する場合、readTemplateのかわりにreadTemplateForUpdateを使用する必要があります。

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

wls:/offline/wls>

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

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

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

構文

readTemplateForUpdate(templateFileName)

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

例

次の例では、テンプレート更新用のwls.jarドメイン・テンプレートを開きます。

wls:/offline> readTemplateForUpdate('C:/Oracle/Middleware/WLS/wlserver/common/templates/wls/wls.jar')
wls:/offline/base_domain>

showAvailableTemplates

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

WLSTでの使用: オフライン

説明

ロード用のすべての現在使用できるテンプレートを表示します。

構文

showAvailableTemplates('showHidden', 'verbose', 'includeApplied')

引数	定義
showHidden	オプション。非表示のテンプレートを表示します。デフォルト値はfalseです。
verbose	オプション。完全なテンプレートの場所のパスを表示します。デフォルト値はfalseです。
includeApplied	オプション。適用されたテンプレートを表示します。デフォルト値はfalseです。

例

wls:/offline> showAvailableTemplates('false','true','false')

showTemplates

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

WLSTでの使用: オフライン

説明

すべての現在選択されているおよびロードされたテンプレートを表示します。

構文

showTemplates()

例

次の例では、すべての現在選択されているおよびロードされたテンプレートを表示します。

wls:/offline> showTemplates()

カスタマイズ・コマンド

表3-4に示すWLSTカスタマイズ・コマンドを使用して、WLST help()およびhelp('commandGroup')コマンドで示されるコマンド・グループ・ヘルプおよびコマンド・ヘルプを追加します。WLSTへのコマンド・ヘルプの追加の詳細は、『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(...)に渡されます。複数のコマンド・グループで同じリソース・バンドルを使用できます。 リソース・バンドルは、クラスパスに指定されている必要があります。 各コマンド・グループおよびコマンドのヘルプ・テキストの定義方法については、『WebLogic Scripting Toolの理解』のカスタム・コマンドの統合型ヘルプの追加に関する項を参照してください。 ResourceBundleおよびローカリゼーションについては、http://java.sun.com/javase/6/docs/api/java/util/ResourceBundle.htmlを参照してください。

例

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

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

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

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

addHelpCommand

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

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

説明

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

構文

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

引数	定義
commandName	commandGroupで指定されたコマンド・グループで定義されるコマンドの名前。
commandGroup	コマンドが属するcommandGroup。
online	オプション。コマンドをhelp('online')出力に表示するかどうかを決定するブール値。デフォルト値はfalseです。
offline	オプション。コマンドをhelp('offline')出力に表示するかどうかを決定するブール値。デフォルト値はfalseです。

例

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

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

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

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

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

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

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

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

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

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

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

deploy

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

WLSTでの使用: オンライン

説明

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

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

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

構文

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

引数	定義
appName	デプロイするスタンドアロンJava EEモジュールまたはアプリケーションの名前。
path	デプロイするアプリケーション・ディレクトリ、アーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。
targets	オプション。対象のカンマ区切りのリスト。各ターゲットをJava EEモジュール名で修飾できます(たとえば、module1@server1)。それによって、別々のサーバーにあるアプリケーション・アーカイブの別々のモジュールをデプロイできます。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。
stageMode	オプション。デプロイするアプリケーションのステージング・モード。有効な値はstage、nostage、およびexternal_stageです。ステージング・モードについては、『Oracle WebLogic Serverへのアプリケーションのデプロイ』のステージング・モードによるデプロイメント・ファイルのコピーの制御に関する項を参照してください。ステージ・モードを指定しない場合、デフォルトのステージ・モードが使用されます。デフォルトのステージ・モードは、管理サーバーではnostageで、管理対象サーバーではstageです。
planPath	オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。
resourceGroup	オプション。このデプロイメントをスコープ指定するリソース・グループの名前。パーティション・リソース・グループまたはドメイン・リソース・グループにデプロイする場合、リソース・グループを指定します。deployコマンドを実行する前に、指定されたリソース・グループはすでに存在する必要があります。
resourceGroupTemplate	オプション。このデプロイメントをスコープ指定するリソース・グループ・テンプレートの名前。deployコマンドを実行する前に、指定されたリソース・グループ・テンプレートはすでに存在する必要があります。
partition	オプション。このデプロイメントをスコープ指定するパーティションの名前。引数が指定されない場合、パーティション名は現在の起動コンテキストから導出されます。deployコマンドを実行する前に、指定されたパーティションはすでに存在する必要があります。
options	オプション。名前と値のペアで指定する、デプロイメント・オプションのカンマ区切りのリスト。有効なオプションは次のとおりです: adminMode - アクセスを制限してWebアプリケーションを起動するかどうかを指定するブール値。このオプションのデフォルトはfalseです。 altDD - 別のディスクリプタを指定します。.earデプロイメント用の別のapplication.xmlまたはスタンドアロン・モジュール・デプロイメント用の別のweb.xmlまたはejb.xmlを指定するために使用される場合があります。 altWlsDD - 管理サーバーにある、代替WebLogicアプリケーション・デプロイメント記述子の場所。 archiveVersion - アーカイブのバージョン番号。 block - コマンドが完了するまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。このオプションのデフォルトはtrueです。falseに設定した場合、WLSTはコマンドの発行後に制御をユーザーに返します。WLSTProgressオブジェクトに問い合わせて、コマンドのステータスを調べることができます。『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。 clusterDeploymentTimeout - このアプリケーションでクラスタのデプロイメント・タスクに認められた時間(ミリ秒単位)。 createPlan - ユーザーがデフォルト・プランを作成するかどうかを示すブール値。このオプションのデフォルトはfalseです。 defaultSubmoduleTargets - 適格JMSサブモジュールの対象指定がシステムによって行われるかどうかを示すブール値。『Oracle WebLogic Serverへのアプリケーションのデプロイ』のJMSアプリケーション・モジュールにおけるサブモジュールの対象指定の使用に関する項を参照してください。デフォルト値はtrueです。 deploymentPrincipalName - サーバーの起動時にファイルまたはアーカイブをデプロイするときに使用されるプリンシパルを示す文字列値(静的デプロイメントであるため、現在のデプロイメント・タスクには影響を与えません)。ユーザーの存在を確認してください。このオプションによって、config.xmlファイルの要素<app-deployment>に<deployment-principal-name>が追加されます。 deploymentOrder - 整数。アプリケーションのデプロイ順序を指定します。最も小さいデプロイ順序値を持つアプリケーションが最初にデプロイされます。 forceUndeployTimeout - アプリケーションをアンデプロイするまで処理中の作業の完了を待つ時間(秒単位)。 gracefulIgnoreSessions - 本番モードから管理モードへの正常な移行の際に保留中のHTTPセッションを無視するかどうかを指定するブール値。このオプションのデフォルトはfalseで、gracefulProductionToAdminがtrueに設定されている場合にのみ適用されます。 gracefulProductionToAdmin - 本番モードから管理モードへの移行を正常に行う必要があるかどうかを指定するブール値。このオプションのデフォルトはfalseです。 libImplVersion - ライブラリの実装バージョン(マニフェストにない場合)。 libraryModule - モジュールがライブラリ・モジュールかどうかを示すブール値。このオプションのデフォルトはfalseです。
options (続き)	libSpecVersion - ライブラリの仕様バージョン(マニフェストにない場合)。 planStageMode - デプロイメント・プランのステージング・モード。有効な値は、stage、nostageまたはexternal_stageです。 planVersion - プランのバージョン番号。 remote - ソースを格納するファイル・システムに対して操作がリモートになるかどうかを指定するブール値。この引数は、管理サーバーとは別のマシンで作業していて、管理サーバーのある指定された場所にすでにデプロイメント・ファイルがある場合に使用します。デフォルトはfalseです。 retireGracefully - すべての処理中の作業が完了した後でのみ、アプリケーションを正常にリタイアするためのリタイアメント・ポリシー。このポリシーは停止および再デプロイ操作でのみ意味があり、リタイアされたタイムアウト・ポリシーと相互に排他的になります。 retireTimeout - 新しいバージョンで置き換えられたアプリケーションをリタイアする前にWLSTが待機する時間(秒単位)。このオプションのデフォルトは-1で、正常なタイムアウトを指定します。 rmiGracePeriod - 新しいバージョンで置き換えられたアプリケーションをリタイアする前にWLSTがRMIリクエストを待機する時間(秒単位)。以前のリクエストの猶予期間内に到着し、その猶予期間中にスケジューリングされたRMIリクエストは受け入れられ、それ以外は却下されます。このオプションのデフォルトは-1で、猶予期間なしが指定されます。 securityModel - セキュリティ・モデル。有効な値はDDOnly、CustomRoles、CustomRolesAndPolicies、およびAdvancedです。 securityValidationEnabled - セキュリティ検証を有効にするかどうかを指定するブール値。 subModuleTargets - JMSモジュールのサブモジュール・レベルの対象。[e-mail]@target | submoduleName@targetなど。 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オブジェクトの詳細は、『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') 

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

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

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

次の例では、デプロイメント・プランplan.xmlを使用して、myapp.earをnostageモードでデプロイする方法を示します。

wls:/mydomain/serverConfig/Servers> progress=deploy('myApp', 
'c:/myapps/myapp.ear', 'mywar@webserver,myjar@ejbserver','
'c:/myapps/plan.xml')
...Deployment of 'myApp' is successful

distributeApplication

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

WLSTでの使用: オンライン

説明

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

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

構文

distributeApplication(appPath, [planPath], [targets], [resourceGroup], [resourceGroupTemplate], [partition], [options])

引数	定義
appPath	デプロイするアーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。
planPath	オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。
targets	オプション。対象のカンマ区切りのリスト。各ターゲットをJava EEモジュール名で修飾できます(たとえば、module1@server1)。それによって、別々のサーバーにあるアプリケーション・アーカイブの別々のモジュールをデプロイできます。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。
resourceGroup	オプション。このデプロイメントをスコープ指定するリソース・グループの名前。パーティション・リソース・グループまたはドメイン・リソース・グループにデプロイする場合、リソース・グループを指定します。distributeApplicationコマンドを実行する前に、指定されたリソース・グループはすでに存在する必要があります。
resourceGroupTemplate	オプション。このデプロイメントをスコープ指定するリソース・グループ・テンプレートの名前。distributeApplicationコマンドを実行する前に、指定されたリソース・グループ・テンプレートはすでに存在する必要があります。
partition	オプション。このデプロイメントをスコープ指定するパーティションの名前。引数が指定されない場合、パーティション名は現在の起動コンテキストから導出されます。distributeApplicationコマンドを実行する前に、指定されたパーティションはすでに存在する必要があります。
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オブジェクトの詳細は、『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。

getWLDM

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

WLSTでの使用: オンライン

説明

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

構文

getWLDM()

例

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

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

listApplications

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

WLSTでの使用: オンライン

説明

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

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

構文

listApplications()

例

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

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

loadApplication

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

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

説明

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

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

注意: loadApplicationコマンドは、リモート・マシンからのアプリケーションのロードをサポートしません。アプリケーションは、管理サーバーが実行されているのと同じマシンにある必要があります。

構文

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

引数	定義
appPath	ロードするアプリケーションが含まれている、最上位の親アプリケーション・ディレクトリ、アーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。ターゲット・アプリケーション・ディレクトリは、管理サーバーが配置されているのと同じマシンにある必要があります。
planPath	オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。
createPlan	オプション。指定されたプランが存在しない場合に、WLSTがアプリケーション・ディレクトリにプランを作成するかどうかを指定するブール値。この引数のデフォルトはtrueです。

例

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

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

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

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

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

redeploy

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

WLSTでの使用: オンライン

説明

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

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

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

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

構文

redeploy(appName, [planPath], [resourceGroupTemplate], [partition], [removePlanOverride], [options])

引数	定義
appName	再デプロイするアプリケーションの名前。
planPath	オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。
resourceGroupTemplate	オプション。このデプロイメントをスコープ指定するリソース・グループ・テンプレートの名前。redeployコマンドを実行する前に、指定されたリソース・グループ・テンプレートはすでに存在する必要があります。
partition	オプション。このデプロイメントをスコープ指定するパーティションの名前。引数が指定されない場合、パーティション名は現在の起動コンテキストから導出されます。redeployコマンドを実行する前に、指定されたパーティションはすでに存在する必要があります。
removePlanOverride	オプション。以前のデプロイメント・プランをリソース・グループ・レベルでオーバーライドするかどうかを示すブール値(trueまたはfalse)を削除する必要があります。このオプションのデフォルトはfalseです。
options	オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。 加えて、redeployコマンドに対しては次のデプロイメント・オプションを指定可能。 appPath - 再デプロイするアーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。 delta - 置き換えられるステージングされたアプリケーションのルートへの相対的なファイル・パスまたはファイル名のリスト。 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オブジェクトの詳細は、『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。

startApplication

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

WLSTでの使用: オンライン

説明

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

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

構文

startApplication(appName, [partition], [options])

引数	定義
appName	plan.xmlファイルに指定されている、起動するアプリケーションの名前。
partition	オプション。このデプロイメントをスコープ指定するパーティションの名前。引数が指定されない場合、パーティション名は現在の起動コンテキストから導出されます。startApplicationコマンドを実行する前に、指定されたパーティションはすでに存在する必要があります。
options	オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

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

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

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

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

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

stopApplication

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

WLSTでの使用: オンライン

説明

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

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

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

構文

stopApplication(appName, [partition], [options])

引数	定義
appName	plan.xmlファイルに指定されている、停止するアプリケーションの名前。
partition	オプション。このデプロイメントをスコープ指定するパーティションの名前。引数が指定されない場合、パーティション名は現在の起動コンテキストから導出されます。stopApplicationコマンドを実行する前に、指定されたパーティションはすでに存在する必要があります。
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オブジェクトの詳細は、『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。

undeploy

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

WLSTでの使用: オンライン

説明

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

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

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

構文

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

引数	定義
appName	デプロイ済のアプリケーションのデプロイメント名。
targets	オプション。アプリケーションを削除するターゲット・サーバーのリスト。指定しない場合は、デフォルトで現在のすべての対象に設定されます。
resourceGroupTemplate	オプション。このデプロイメントをスコープ指定するリソース・グループ・テンプレートの名前。undeployコマンドを実行する前に、指定されたリソース・グループ・テンプレートはすでに存在する必要があります。
partition	オプション。このデプロイメントをスコープ指定するパーティションの名前。引数が指定されない場合、パーティション名は現在の起動コンテキストから導出されます。undeployコマンドを実行する前に、指定されたパーティションはすでに存在する必要があります。
options	オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

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

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

updateApplication

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

WLSTでの使用: オンライン

説明

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

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

構文

updateApplication(appName, [planPath], [resourceGroupTemplate], [partition], [removePlanOverride], [options])

引数	定義
appName	現在のplan.xmlファイルに指定されているアプリケーションの名前。
planPath	オプション。新しいデプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。
resourceGroupTemplate	オプション。このデプロイメントをスコープ指定するリソース・グループ・テンプレートの名前。updateApplicationコマンドを実行する前に、指定されたリソース・グループ・テンプレートはすでに存在する必要があります。
partition	オプション。このデプロイメントをスコープ指定するパーティションの名前。引数が指定されない場合、パーティション名は現在の起動コンテキストから導出されます。updateApplicationコマンドを実行する前に、指定されたパーティションはすでに存在する必要があります。
removePlanOverride	オプション。以前のデプロイメント・プランをリソース・グループ・レベルでオーバーライドするかどうかを示すブール値(trueまたはfalse)を削除する必要があります。このオプションのデフォルトはfalseです。
options	オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

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

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

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

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

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

診断コマンド

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

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

コマンド	説明	WLSTの使用...
activateDebugPatch	指定されたターゲットのデバッグ・パッチをアクティブ化します。	オンライン
captureAndSaveDiagnosticImage	診断イメージを取得し、クライアントにダウンロードします。	オンライン
createSystemResourceControl	指定されたディスクリプタ・ファイルを使用して診断システム・リソース管理を作成します。	オンライン
deactivateAllDebugPatches	指定されたターゲットのすべてのデバッグ・パッチを非アクティブ化します。	オンライン
deactivateDebugPatches	指定されたターゲットのデバッグ・パッチを非アクティブ化します。	オンライン
destroySystemResourceControl	診断システム・リソース管理を破棄します。	オンライン
disableSystemResource	サーバー・インスタンスでアクティブ化されている診断システム・リソース管理を非アクティブ化します。	オンライン
dumpDiagnosticData	特定のWLDFシステム・リソースのハーベスタ構成に一致するライブ・データをポーリングし、ローカル・ファイルにダンプします。	オンライン
enableSystemResource	サーバー・インスタンスで診断システム・リソースをアクティブ化します。	オンライン
exportDiagnosticData	指定されたログ・ファイルに対する問合せを実行します。	オフライン
exportDiagnosticDataFromServer	サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。	オンライン
exportHarvestedTimeSeriesData	CSV形式で指定された間隔内に収集されたメトリック・データをエクスポートします。	オンライン
exportHarvestedTimeSeriesDataOffline	CSV形式で指定された間隔内にオフライン・モードで収集されたメトリック・データをエクスポートします。	オフライン
getAvailableCapturedImages	以前に取得した診断イメージのリストを返します。	オンライン
getAvailableDiagnosticDataAccessorNames	サーバーまたはパーティションで現在使用できる診断データ・アクセサ名を取得します。	オンライン
listDebugPatches	指定されたターゲットのアクティブな使用できるデバッグ・パッチをリストします。	オンライン
listDebugPatchTasks	指定されたターゲットからデバッグ・パッチ・タスクをリストします。	オンライン
listSystemResourceControls	現在サーバー・インスタンスにデプロイされている診断システム・リソースをリストします。	オンライン
mergeDiagnosticData	データ・ファイルのセットをマージします。	オンライン
purgeCapturedImages	指定された期間の基準に従って、サーバーの診断イメージ・ファイルをパージします。	オンライン
purgeDebugPatchTasks	指定されたターゲットからデバッグ・パッチ・タスクをパージします。	オンライン
showDebugPatchInfo	指定されたターゲットのデバッグ・パッチの詳細を表示します。	オンライン
saveDiagnosticImageCaptureFile	指定された診断イメージ・キャプチャをダウンロードします。	オンライン
saveDiagnosticImageCaptureEntryFile	診断イメージ・キャプチャから特定のエントリをダウンロードします。	オンライン

activateDebugPatch

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

WLSTでの使用: オンライン

説明

指定されたターゲットのデバッグ・パッチをアクティブ化します。管理サーバーの接続中に、オプションのtargetパラメータを指定して、複数の管理対象サーバーおよびクラスタのデバッグ・パッチをアクティブ化できます。targetパラメータを指定しない場合、デバッグ・パッチは接続されたサーバーでのみアクティブ化されます。

activateDebugPatchコマンドは、タスクの配列を返します。各要素は、影響を受けるターゲット・サーバー・インスタンスのアクティブ化アクティビティに対応します。

構文

activateDebugPatch(patch, [options])

引数	説明
patch	アクティブ化するデバッグ・パッチの名前。パッチは、適用可能なターゲット・サーバーに存在する必要があります。listDebugPatchesコマンドを使用して、ターゲット・サーバーのアクティブな使用できるパッチのリストを表示します。
options	app - 指定されたアプリケーションのスコープ内でデバッグ・パッチをアクティブ化します。指定しない場合、デバッグ・パッチはシステム・レベルでアクティブ化されます。デフォルト値はNoneです。 module - アプリケーションの指定されたモジュールのスコープ内でデバッグ・パッチをアクティブ化します。appオプションがNoneに設定され、デバッグ・パッチがシステム・レベルでアクティブ化されている場合、このオプションは無視されます。 partition - 指定されたパーティションのスコープ内でデバッグ・パッチをアクティブ化します。appオプションがNoneに設定され、デバッグ・パッチがシステム・レベルでアクティブ化されている場合、このオプションは無視されます。 target - 管理サーバーのみ。デバッグ・パッチがアクティブ化される場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値はNoneです。

例

次の例では、クラスタmyCluster、パーティションmyPartition、アプリケーションmyappのスコープ内でdyndebug_app01.jarデバッグ・パッチをアクティブ化します。

wls:/dyndebugDomain/serverConfig> tasks=activateDebugPatch('dyndebug_app01.jar', app='myapp', partition='myPartition', target='myCluster')

captureAndSaveDiagnosticImage

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

WLSTでの使用: オンライン

説明

診断イメージを取得し、クライアントにダウンロードします。

構文

captureAndSaveDiagnosticImage([options])

引数	説明
options	このコマンドは次のオプションをサポートしています。 Server - 管理サーバーのみ。ターゲット・サーバーの名前。デフォルト値はNoneです。このオプションはTargetオプションに置き換わっており、すべてのWLSTスクリプトを、Targetを使用するように更新する必要があります。 Target - 管理サーバーのみ。サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値はNoneです。 outputFile - イメージを保存するファイル。 outputDir - 複数のファイルが取得された場合に、イメージ・ファイルをコピーする宛先ディレクトリ。デフォルト値は現行ディレクトリです。 partition - イメージ・ファイルを取得するパーティションの名前。

例

次の例では、クラスタCluster-0のメンバーのサーバーmyserverの診断イメージをキャプチャし、クライアントで取得します。

wls:/mydomain/serverConfig> captureAndSaveDiagnosticImage(Target='myserver,Cluster-0')
Capture and save diagnostics images
Image created on the server diagnostic_image_MS1_2013_09_19_16_20_49.zip
Saving diagnostic image diagnostic_image_MS1_2013_09_19_16_20_49.zip from server MS1 to diagnostic_image_MS1_2013_09_19_16_20_49.zip
Image created on the server diagnostic_image_MS2_2013_09_19_16_20_51.zip
Saving diagnostic image diagnostic_image_MS2_2013_09_19_16_20_51.zip from server MS2 to diagnostic_image_MS2_2013_09_19_16_20_51.zip
Image created on the server diagnostic_image_myserver_2013_09_19_16_20_53.zip
Saving diagnostic image diagnostic_image_myserver_2013_09_19_16_20_53.zip from server myserver to diagnostic_image_myserver_2013_09_19_16_20_53.zip

次の例では、指定されたパーティションの診断イメージをキャプチャし、クライアントで取得します。

wls:/partitionDomain/serverConfig> captureAndSaveDiagnosticImage(partition='p1')
Capture and save diagnostics images
Image created on the server diagnostic_image__p1_e0774122-58e8-421b-963b-d076096a72cf_partitionAdmin_2015_01_23_12_50_38.zip
Saving diagnostic image diagnostic_image__p1_e0774122-58e8-421b-963b-d076096a72cf_partitionAdmin_2015_01_23_12_50_38.zip from server  to diagnostic_image__p1_e0774122-58e8-421b-963b-d076096a72cf_partitionAdmin_2015_01_23_12_50_38.zip for partition p1

createSystemResourceControl

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

WLSTでの使用: オンライン

説明

診断ディスクリプタ・ファイルから、ドメインの構成を変えずに診断リソースを作成します。リソースがメモリー内に残るのは、サーバーが停止するまでの間のみです。次のサーバーの起動時には、リソースはデプロイされません。つまり、このコマンドは実行時の変更にのみ有効であり、構成は変更されません。

構文

createSystemResourceControl(resourceName, descriptorFile, [options])

引数	定義
resourceName	診断リソースの名前。 注意: リソースは、enableSystemResource()関数を使用して別途有効にし、リソース自体の各機能も有効にしておく必要があります。
descriptorFile	診断ディスクリプタ・ファイルへのローカル・パス。
options	Server - 管理サーバーのみ。ターゲット・サーバー名。デフォルト値はNoneです。このオプションはTargetオプションに置き換わっており、すべてのWLSTスクリプトを、Targetを使用するように更新する必要があります。 Target - サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値はNoneです。 enabled - trueに設定すると、システム・リソースの作成後、そのシステム・リソースが有効になります。デフォルト値はfalseです。enableSystemResourceコマンドとdisableSystemResourceコマンドを使用すれば、リソースを個別に有効化または無効化できます。また、リソースの機能をアクティブにするには有効化する必要があります。

例

次の例では、サーバー・ターゲットmyserverとクラスタ・ターゲットmyclusterを指定し、診断ディスクリプタ・ファイルmywldf.xmlからmyExternalResourceというシステム・リソース管理を作成します。リソース管理は有効になりません。

wls:/mydomain/serverRuntime>createSystemResourceControl('myExternalResource', 
'C:/temp/mywldf.xml', Target='myserver,mycluster')

次の例では、サーバー・ターゲットmyserverとクラスタ・ターゲットmyclusterを指定し、診断ディスクリプタ・ファイルmywldf.xmlからmyExternalResourceというシステム・リソース管理を作成して有効化します。

wls:/mydomain/serverRuntime>createSystemResourceControl('myExternalResource', 
'C:/temp/mywldf.xml', Target='myserver,mycluster', enabled='true')

次の例では、診断ディスクリプタ・ファイルmywldf.xmlからmyExternalResourceというシステム・リソース管理を作成して有効化します。ターゲットが指定されていないため、ターゲットはデフォルトの現在接続しているサーバーになります。

wls:/mydomain/serverRuntime>createSystemResourceControl('myExternalResource', 
'C:/temp/mywldf.xml', enabled='true')

deactivateAllDebugPatches

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

WLSTでの使用: オンライン

説明

指定されたターゲットのすべてのデバッグ・パッチを非アクティブ化します。管理サーバーの接続中に、オプションのtargetパラメータを指定して、複数の管理対象サーバーおよびクラスタのすべてのデバッグ・パッチを非アクティブ化できます。targetパラメータを指定しない場合、接続されたサーバーのデバッグ・パッチのみが非アクティブ化されます。

deactivateAllDebugPatchesコマンドは、タスクの配列を返します。各要素は、影響を受けるターゲット・サーバー・インスタンスの非アクティブ化アクティビティに対応します。

構文

deactivateAllDebugPatches([target])

引数	定義
target	オプション。管理サーバーのみ。デバッグ・パッチが非アクティブ化される場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値はNoneです。指定しない場合、接続されたサーバーのデバッグ・パッチのみが非アクティブ化されます。

例

次の例では、クラスタmyClusterのすべてのデバッグ・パッチを非アクティブ化します。

wls:/dyndebugDomain/serverConfig> tasks=deactivateAllDebugPatches(target='myCluster')

deactivateDebugPatches

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

WLSTでの使用: オンライン

説明

指定されたターゲットのデバッグ・パッチを非アクティブ化します。管理サーバーの接続中に、オプションのtargetパラメータを指定して、複数の管理対象サーバーおよびクラスタのデバッグ・パッチを非アクティブ化できます。targetパラメータを指定しない場合、接続されたサーバーのデバッグ・パッチのみが非アクティブ化されます。

deactivateDebugPatchesコマンドは、タスクの配列を返します。各要素は、影響を受けるターゲット・サーバー・インスタンスの非アクティブ化アクティビティに対応します。

構文

deactivateDebugPatches(patches, [options])

引数	説明
patches	非アクティブ化するデバッグ・パッチのカンマ区切りリスト。
options	app - 指定されたアプリケーションのスコープ内でデバッグ・パッチを非アクティブ化します。指定しない場合、デバッグ・パッチはシステム・レベルで非アクティブ化されます。デフォルト値はNoneです。 module - アプリケーションの指定されたモジュールのスコープ内でデバッグ・パッチを非アクティブ化します。appオプションがNoneに設定され、デバッグ・パッチがシステム・レベルで非アクティブ化される場合、このオプションは無視されます。 partition - 指定されたパーティションのスコープ内でデバッグ・パッチを非アクティブ化します。appオプションがNoneに設定され、デバッグ・パッチがシステム・レベルで非アクティブ化される場合、このオプションは無視されます。 target - 管理サーバーのみ。デバッグ・パッチが非アクティブ化される場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値はNoneです。

例

次の例では、クラスタmyCluster、パーティションmyPartition、アプリケーションmyappのスコープ内でデバッグ・パッチのリストを非アクティブ化します。

wls:/dyndebugDomain/serverConfig> tasks=deactivateDebugPatches('dyndebug_app01.jar,dyndebug_app02.jar', app='myapp', partition='myPartition', target='myCluster')

destroySystemResourceControl

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

WLSTでの使用: オンライン

説明

外部ディスクリプタから、createSystemResourceControl()関数を使用してデプロイされた診断リソースを破棄します。

注意: 診断リソースを破棄しないで無効にするには、disableSystemResource()コマンドを使用します。

構文

destroySystemResourceControl(resourceName, [options])

引数	定義
resourceName	診断リソースの名前。 注意: リソースは、enableSystemResource()関数を使用して別途有効にし、リソース自体の各機能も有効にしておく必要があります。
options	Server - 管理サーバーのみ。リソースが現在デプロイされているサーバーの名前。デフォルト値はNoneです。このオプションはTargetオプションに置き換わっており、すべてのWLSTスクリプトを、Targetを使用するように更新する必要があります。 Target - リソースが現在デプロイされているサーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値はNoneです。

例

次の例では、myserverサーバーにデプロイされていたmyExternalResourceという診断システム・リソース管理を破棄します。

wls:/mydomain/serverRuntime>destroySystemResourceControl('myExternalResource', Target='myserver')

disableSystemResource

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

WLSTでの使用: オンライン

説明

サーバー・インスタンスで有効になっている診断システム・リソース管理を非アクティブ化します。

構文

disableSystemResource(resourceName, [options])

引数	定義
resourceName	診断リソースの名前。 注意: リソースは、enableSystemResource()関数を使用して別途有効にし、リソース自体の各機能も有効にしておく必要があります。
options	Server - 管理サーバーのみ。ターゲット・サーバー名。デフォルト値はNoneです。このオプションはTargetオプションに置き換わっており、すべてのWLSTスクリプトを、Targetを使用するように更新する必要があります。 Target - サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値はNoneです。

例

次の例では、myserverサーバーでアクティブ化されているmySystemResourceという診断システム・リソースを非アクティブ化します。

wls:/mydomain/serverRuntime>disableSystemResource('mySystemResource',Target='myserver')

dumpDiagnosticData

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

WLSTでの使用: オンライン

説明

特定のWLDFシステム・リソースのハーベスタ構成に一致するライブ診断データを、指定した頻度および期間でポーリングし、ローカル・ファイルにダンプします。データはCSV形式で書き込まれます。

連続するサンプリング期間の間で収集されたデータ・セットに変更が検出された場合は、新しい出力ファイルが作成され、情報メッセージが表示されます。サンプリング間隔が特に長いと、複数の出力ファイルが作成されることがあります。これらのデータ・ファイルは、mergeDiagnosticDataコマンドを使用してマージできます。

構文

dumpDiagnosticData(resourceName, filename, frequency, duration, [options])

引数	定義
resourceName	データのポーリング元となるシステム・リソースの名前。 注意: リソースは、enableSystemResource()関数を使用して別途有効にし、リソース自体の各機能も有効にしておく必要があります。
filename	データのダンプ先となるファイルの名前。
frequency	データがシステム・リソース・ハーベスタからポーリングされる頻度(ミリ秒)。
duration	データが収集され、保存されるまでの合計所要時間(ミリ秒)。
options	Server - 管理サーバーのみ。システム・リソースが実行されているサーバーの名前。 dateFormat - SimpleDateFormatパターン。デフォルトは、EEE MM/dd/YY k:mm:ss:SSS zです。

例

次の例では、サーバーmyserverのmySystemResourceの診断ハーベスタ・データをローカル・ファイルC:\temp\temp.datにダンプし、日付フォーマットをHH:mm:ss:SSSに設定します。

wls:/mydomain/serverRuntime>dumpDiagnosticData('mySystemResource',
'C:/temp/temp.dat',1000,6000,Server='myserver',dateFormat='HH:mm:ss:SSS')

Connecting to http://localhost:7001 with userid weblogic ...
Dumping data for system resource mySystemResource in file temp.data every second  for 6 seconds.

enableSystemResource

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

WLSTでの使用: オフライン

説明

サーバー・インスタンスで診断システム・リソースをアクティブ化します。

構文

enableSystemResource(resourceName, [options]

引数	定義
resourceName	診断システム・リソースの名前。
options	Server - 管理サーバーのみ。ターゲット・サーバー名。デフォルト値はNoneです。このオプションはTargetオプションに置き換わっており、すべてのWLSTスクリプトを、Targetを使用するように更新する必要があります。 Target - サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値はNoneです。

例

次の例では、myServerサーバーの診断システム・リソースmySystemResourceをアクティブ化します。

wls:/mydomain/serverRuntime>enableSystemResource('mySystemResource',Target='myserver')

exportDiagnosticData

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

WLSTでの使用: オフライン

説明

指定されたログ・ファイルに対する問合せを実行します。結果はXML、CSVまたはTXTファイルとして保存されます。デフォルトの出力形式はXMLです。

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

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

構文

exportDiagnosticData([options])

引数

定義

options

オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: beginTimestamp - 結果セットに追加する最も早い記録のタイム・スタンプ(そのタイム・スタンプを含む)。このオプションのデフォルトは0です。 endTimestamp - 結果セットに追加する最も遅い記録のタイム・スタンプ(そのタイム・スタンプを含まない)。このオプションのデフォルトはLong.MAX_VALUEです。 exportFileName - データのエクスポート先になるファイルの名前。このオプションのデフォルトはexport.xmlです。 logicalName - 読み込まれるログ・ファイルの論理名。有効な値は、HarvestedDataArchive、EventsDataArchive、ServerLog、DomainLog、HTTPAccessLog、WebAppLog、ConnectorLog、およびJMSMessageLogです。このオプションのデフォルトはServerLogです。 logName - エクスポートするログ・データが含まれている基本ログ・ファイル名。このオプションのデフォルトは、現行ディレクトリのmyserver.logです。 logRotationDir - ローテーションされるログ・ファイルが含まれるディレクトリ。このオプションのデフォルトは「.」(ログ・ファイルが格納されているディレクトリと同じディレクトリ)です。 query - 結果セットに含まれるデータ記録のフィルタ条件を指定する式。このオプションのデフォルトは"" (空の文字列)で、すべてのデータが返されます。詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』のWLDF問合せ言語に関する項を参照してください。 storeDir - サーバーの診断ストアの場所。このオプションのデフォルトは../data/store/diagnosticsです。 format - データをエクスポートする形式。サポートされている形式は、xml、txtおよびcsvです。デフォルトの形式はxmlです。 last - 最後のnレコードのタイムスタンプ範囲指定。指定された場合、beginTimestampおよびendTimestampオプションは無視されます。形式はXXd YYh ZZmです。たとえば、1d 5h 30mは、1日5時間30分のデータを指定します。日、時間、分を任意の順序の組合せで指定できます。

例

次の例では、myserver.logという名前のServerLogに対して問合せを実行し、その結果をmyExport.xmlというファイルに格納します。

wls:/offline/mydomain>exportDiagnosticData(logicalName='ServerLog',  
logName='myserver.log', exportFileName='myExport.xml')
Input parameters: {'elfFields': '', 'logName': 'myserver.log', 'logRotationDir': 
'.', 'endTimestamp': 9223372036854775807L, 'exportFileName': 'export.xml',
'storeDir': '../data/store/diagnostics', 'logicalName': 'ServerLog',
'query': '', 'beginTimestamp': 0}

Exporting diagnostic data to export.xml
<Aug 2, 2005 6:58:21 PM EDT> <Info> <Store> <BEA-280050> <Persistent store
 "WLS_DIAGNOSTICS" opened: directory="c:\Oracle\Middleware
\wlserver\server\data\store\diagnostics"
 writePolicy="Disabled" blockSize=512 directIO=false driver="wlfileio2">

exportDiagnosticDataFromServer

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

WLSTでの使用: オンライン

説明

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。結果はXML、CSVまたはTXTファイルとして保存されます。デフォルトの出力形式はXMLです。このコマンドには、管理対象サーバーへのセキュアな接続を持っていることが必要です。

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

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

構文

exportDiagnosticDataFromServer([options])

引数

定義

options

オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: beginTimestamp - 結果セットに追加する最も早い記録のタイム・スタンプ(そのタイム・スタンプを含む)。このオプションのデフォルトは0です。 endTimestamp - 結果セットに追加する最も遅い記録のタイム・スタンプ(そのタイム・スタンプを含まない)。このオプションのデフォルトはLong.MAX_VALUEです。 exportFileName - データのエクスポート先になるファイルの名前。このオプションのデフォルトはexport.xmlです。 logicalName - 読み込まれるログ・ファイルの論理名。有効な値は、HarvestedDataArchive、EventsDataArchive、ServerLog、DomainLog、HTTPAccessLog、WebAppLog、ConnectorLog、およびJMSMessageLogです。このオプションのデフォルトはServerLogです。 query - 結果セットに含まれるデータ記録のフィルタ条件を指定する式。このオプションのデフォルトは"" (空の文字列)で、すべてのデータが返されます。 server - データの取得元となる管理対象サーバーの名前。このオプションは、管理サーバーに現在接続している場合にのみ使用できます。デフォルトでは、データはWLSTが接続しているサーバーからのみ取得されます。 partition - データを取得するパーティションの名前。 format - データをエクスポートする形式。サポートされている形式は、xml、txtおよびcsvです。デフォルトの形式はxmlです。 last - 最後のnレコードのタイムスタンプ範囲指定。指定された場合、beginTimestampおよびendTimestampオプションは無視されます。形式はXXd YYh ZZmです。たとえば、1d 5h 30mは、1日5時間30分のデータを指定します。日、時間、分を任意の順序の組合せで指定できます。

例

次の例では、HTTPAccessLogに対して問合せを実行し、その結果をmyExport.xmlというファイルに格納します。

wls:/mydomain/serverRuntime> exportDiagnosticDataFromServer(logicalName="HTTPAccessLog", exportFileName="myExport.xml") 

exportHarvestedTimeSeriesData

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

WLSTでの使用: オンライン

説明

特定のサーバー・スコープ指定またはパーティション・スコープ指定のWLDFシステム・リソースの診断アーカイブから収集されたメトリック・データをエクスポートします。

メトリック・コレクションのハーベスタの構成の詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』を参照してください。

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

構文

exportHarvestedTimeSeriesData(wldfSystemResource, [options])

引数	定義
wldfSystemResource	収集されたデータをエクスポートするWLDFシステム・リソースの名前。
options	エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: beginTimestamp - 取得する収集されたデータの開始タイムスタンプ。 endTimestamp - 取得する収集されたデータの終了タイムスタンプ。 exportFile - エクスポートされたデータがCSV形式で書き込まれるファイルのパス。 server - WLDFシステム・リソースを実行しているサーバーおよび収集されたデータを取得するサーバーの名前。このオプションは、WLSTを管理サーバーに接続している場合にのみ使用できます。指定しない場合、データはWLSTを接続するサーバーから取得されます。 last - 最後のnレコードのタイムスタンプ範囲指定。指定された場合、beginTimestampおよびendTimestampオプションは無視されます。形式はXXd YYh ZZmです。たとえば、1d 5h 30mは、1日5時間30分のデータを指定します。日、時間、分を任意の順序の組合せで指定できます。 partition - 収集されたデータをエクスポートするパーティションの名前。 dateFormat - 収集されたデータのタイムスタンプをレンダリングするjava.text.SimpleDateFormat構文に準拠するパターン文字列。形式は、EEE MM/dd/YY k:mm:ss:SSS zです。

例

次の例では、myserverサーバーで実行されているWLDFシステム・リソースwldf-1から収集された診断データをエクスポートし、データをexport.csvというファイルに書き込みます。

wls:/mydomain/serverRuntime>exportHarvestedTimeSeriesData('wldf-1')
Getting diagnostic data from Server myserver.
Opening new capture file export.csv...

exportHarvestedTimeSeriesDataOffline

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

WLSTでの使用: オフライン

説明

サーバーが実行されていない場合にオフライン・モードでWLDFシステム・リソースの診断アーカイブから収集されたメトリック・データをエクスポートします。

メトリック・コレクションのハーベスタの構成の詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』を参照してください。

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

構文

exportHarvestedTimeSeriesDataOffline(wldfSystemResource, [options])

引数	定義
wldfSystemResource	収集されたデータをエクスポートするWLDFシステム・リソースの名前。
options	オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです: beginTimestamp - 取得する収集されたデータの開始タイムスタンプ。 endTimestamp - 取得する収集されたデータの終了タイムスタンプ。 exportFile - エクスポートされたデータがCSV形式で書き込まれるファイルのパス。 last - 最後のnレコードのタイムスタンプ範囲指定。指定された場合、beginTimestampおよびendTimestampオプションは無視されます。形式はXXd YYh ZZmです。たとえば、1d 5h 30mは、1日5時間30分のデータを指定します。日、時間、分を任意の順序の組合せで指定できます。 dateFormat - 収集されたデータのタイムスタンプをレンダリングするjava.text.SimpleDateFormatパターン文字列。形式は、EEE MM/dd/YY k:mm:ss:SSS zです。 storeDir - WLDFストア・ディレクトリのパス。サーバー・インスタンスの診断データ・ストアは、サーバーのルート・ディレクトリの下のdata/store/diagnosticsディレクトリにあります。

例

次の例では、オフライン・モードでWLDFシステム・リソースwldf-1から収集された診断データをエクスポートし、データをexport.csvというファイルに書き込みます。

wls:/offline> exportHarvestedTimeSeriesDataOffline(wldfSystemResource='wldf-1')
Opening new capture file export.csv ...

getAvailableCapturedImages

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

WLSTでの使用: オンライン

説明

サーバーで構成したイメージの宛先ディレクトリに格納される以前に捕捉した診断イメージのリストを文字列の配列で戻します。デフォルトのディレクトリはSERVER\logs\diagnostic_imagesです。

このコマンドは、ダウンロードする診断イメージ・キャプチャの識別または特定のエントリをダウンロードする診断イメージ・キャプチャの識別に役立ちます。

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

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

構文

getAvailableCapturedImages([options])

引数	定義
options	Server - (管理サーバーのみ)使用可能なイメージのリストの取得元となるサーバー。デフォルト値はNoneです。 partition - 使用できる診断イメージのリストを取得するパーティションの名前。

例

次の例では、イメージの宛先ディレクトリで使用できる診断イメージ・キャプチャ・ファイルのリストを含むimagesという文字列の配列を戻し、diagnostic_image_myserver_2009_06_15_14_58_36.zipという診断イメージに含まれるエントリを出力します。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverRuntime>print images]
'diagnostic_image_myserver_2009_06_15_14_58_36.zip']
]

次の例では、管理対象サーバーMS1について、イメージの宛先ディレクトリで使用できる診断イメージ・キャプチャ・ファイルのリストを含むimagesという文字列の配列を戻し、diagnostic_image_MS1_2013_09_18_15_59_31.zipおよびdiagnostic_image_MS1_2013_09_18_16_02_58.zipという診断イメージに含まれるエントリを出力します。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages(Server='MS1')
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverRuntime>print images
['diagnostic_image_MS1_2013_09_18_15_59_31.zip', 'diagnostic_image_MS1_2013_09_18_16_02_58.zip']

getAvailableDiagnosticDataAccessorNames

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

WLSTでの使用: オンライン

説明

サーバーまたはパーティションで現在使用できる診断データ・アクセサ・インスタンスの論理名を取得し、文字列値の配列として戻します。

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

構文

getAvailableDiagnosticDataAccessorNames([options])

引数	定義
options	server - 使用できるデータ・アクセサ名のリストを取得するサーバー。指定しない場合、データは、WLSTを接続している現在のサーバーから取得されます。このオプションは、WLSTが管理サーバーに接続している場合にのみ適用できます。デフォルト値はNoneです。 partition - 使用できるデータ・アクセサ名のリストを取得するパーティションの名前。

例

次の例では、myserverサーバーから診断データ・アクセサ名を取得し、文字列値の配列として戻します。

wls:/mydomain/serverRuntime>names=getAvailableDiagnosticDataAccessorNames()
Getting diagnostic data from Server myserver.
wls:/mydomain/serverRuntime>print names
array(java.lang.String,['HarvestedDataArchive', 'EventsDataArchive', 'DataSourceLog', 'DomainLog', 'HTTPAccessLog', 'ServerLog'])

listDebugPatches

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

WLSTでの使用: オンライン

説明

指定されたターゲットのアクティブな使用できるデバッグ・パッチをリストします。管理サーバーの接続中に、オプションのtargetパラメータを指定して、複数の管理対象サーバーおよびクラスタのデバッグ・パッチをリストできます。

構文

listDebugPatches([target])

引数	定義
target	オプション。管理サーバーのみ。アクティブな使用できるデバッグ・パッチが示される場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値はNoneです。指定しない場合、接続されたサーバーからのデバッグ・パッチのリストのみ表示されます。

例

次の例では、クラスタmyClusterのアクティブな使用できるデバッグ・パッチを示します。

ms1およびms2というラベルの列は、それぞれ管理対象サーバーms1およびms2でデプロイされているアクティブな使用できるパッチを示します。

wls:/dyndebugDomain/serverConfig> listDebugPatches('myCluster')
ms1:
Active Patches:
    dyndebug01.jar:system
    dyndebug_app01.jar:app=myapp
    dyndebug_app02.jar:app=myapp
Available Patches:
    dyndebug00.jar
    dyndebug01.jar
    dyndebug02.jar
    dyndebug03.jar
    dyndebug04.jar
    dyndebug05.jar
    dyndebug_app01.jar
    dyndebug_app02.jar
    dyndebug_app03.jar

ms2:
Active Patches:
    dyndebug01.jar:system
    dyndebug_app01.jar:app=myapp
    dyndebug_app02.jar:app=myapp
Available Patches:
    dyndebug00.jar
    dyndebug01.jar
    dyndebug02.jar
    dyndebug03.jar
    dyndebug04.jar
    dyndebug05.jar
    dyndebug_app01.jar
    dyndebug_app02.jar
    dyndebug_app03.jar

listDebugPatchTasks

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

WLSTでの使用: オンライン

説明

指定されたターゲットからデバッグ・パッチ(アクティブ化または非アクティブ化)・タスクを示します。管理サーバーの接続中に、オプションのtargetパラメータを指定して、複数の管理対象サーバーおよびクラスタのタスクをリストできます。targetパラメータを指定しない場合、接続されたサーバーのタスクのみが示されます。

構文

listDebugPatchTasks([target])

引数	定義
target	オプション。管理サーバーのみ。デバッグ・パッチ・タスクが示される場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値はNoneです。指定しない場合、接続されたサーバーのデバッグ・パッチ・タスクのリストのみが示されます。

例

次の例では、クラスタmyClusterからデバッグ・パッチ・タスクを示します。

ms1およびms2というラベルの列は、それぞれ管理対象サーバーms1およびms2からアクティブ化および非アクティブ化されたパッチ・タスクを示します。

wls:/dyndebugDomain/serverConfig> tasks=listDebugPatchTasks(target='myCluster')
ms1:
  [1] DEACTIVATE_4 DEACTIVATE *  FINISHED
  [2] ACTIVATE_5 ACTIVATE dyndebug01.jar  FAILED
  [3] ACTIVATE_6 ACTIVATE dyndebug_app01.jar  FINISHED
  [4] DEACTIVATE_7 DEACTIVATE dyndebug01.jar  FINISHED
 
 
ms2:
  [1] DEACTIVATE_4 DEACTIVATE *  FINISHED
  [2] ACTIVATE_5 ACTIVATE dyndebug01.jar  FAILED
  [3] ACTIVATE_6 ACTIVATE dyndebug_app01.jar  FINISHED
  [4] DEACTIVATE_7 DEACTIVATE dyndebug01.jar  FINISHED

listSystemResourceControls

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

WLSTでの使用: オンライン

説明

現在のサーバーまたは指定したターゲット上にあるシステム・リソース管理MBeanをすべて表示します。

構文

listSystemResourceControls([options])

引数	定義
options	Server - 管理サーバーのみ。システム・リソース管理の表示元となるターゲット・サーバー名。デフォルト値はNoneです。このオプションはTargetオプションに置き換わっており、すべてのWLSTスクリプトを、Targetを使用するように更新する必要があります。 Target - システム・リソース管理の表示元となるサーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値はNoneです。

例

次の例では、myServerサーバーにデプロイされた診断システム・リソースをリストします。

• Externalというラベルの列は、診断システム・リソースが外部リソース・ディスクリプタで定義されているかどうかを示します。

• Enabledというラベルの列は、診断リソースが、そのリソースが構成されているサーバー上でアクティブになっているかどうかを示します。

wls:/mydomain/serverConfig> listSystemResourceControls('myServer')
External  Enabled   Name
--------  -------   ------------------------------
false     false     Module-0
false     false     allprofiles
true      true      MyExternal
false     true      Low
false     false     FPP-module

mergeDiagnosticData

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

WLSTでの使用: オンライン

説明

dumpDiagnosticData()コマンドで生成済のデータ・ファイル・セットをマージし、inputDir引数で指定されたディレクトリに1つのマージ済ファイルを作成します。指定したディレクトリにあるすべてのファイルのデータが統合され、CSV形式で書き込まれます。

構文

mergeDiagnosticData([inputDir], [options]

引数	定義
inputDir	診断データ・ファイルが格納されているソース・ディレクトリの名前。
options	toFile - マージされたターゲット・データ・ファイルの名前。デフォルトはmerged.csvです。

例

この例では、/home/mydir/dataディレクトリにあるすべてのデータ・ファイルを1つのデータ・ファイルmymergedata.csvにマージします。

wls:/mydomain/serverRuntime>mergeDiagnosticData('/home/mydir/data', 
toFile='mymergedata.csv')

purgeCapturedImages

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

WLSTでの使用: オンライン

説明

サーバーで構成したイメージの宛先ディレクトリから指定された期間の基準に従って、サーバーの診断イメージ・ファイルをパージします。

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

構文

purgeCapturedImages([options])

引数	定義
options	server - 管理サーバーのみ。使用できるイメージのリストをパージするサーバーの名前。指定しない場合、デフォルトのNoneになります。 partition - 診断イメージをパージするパーティションの名前。指定しない場合、サーバーのすべてのイメージがパージされます。指定しない場合、デフォルトはNoneになります。 age - 指定された有効期間より古い診断イメージがパージされます。有効期間は形式Days:Hours:Minutesで指定されます。時間と分はオプションです。有効期間を指定しない場合、すべての既存のイメージ・ファイルがパージされます。

例

次の例では、管理対象サーバーMS1、パーティションtestPartitionから15日12時間30分より古いイメージをパージします。

wls:/mydomain/serverConfig> purgeCapturedImages("15:12:30", server="MS1", partition="testPartition")

purgeDebugPatchTasks

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

WLSTでの使用: オンライン

説明

指定されたターゲットのデバッグ・パッチ(アクティブ化または非アクティブ化)・タスクをパージします。管理サーバーの接続中に、オプションのtargetパラメータを指定して、複数の管理対象サーバーおよびクラスタのタスクをパージできます。targetパラメータを指定しない場合、接続されたサーバーのタスクのみがパージされます。完了後、失敗したまたは取り消されたタスクがパージされます。

構文

purgeDebugPatchTasks([target])

引数	定義
target	オプション。管理サーバーのみ。デバッグ・パッチ・タスクがパージされる場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値はNoneです。指定しない場合、接続されたサーバーのデバッグ・パッチ・タスクのリストのみがパージされます。

例

次の例では、クラスタmyClusterからデバッグ・パッチ・タスクをパージします。

wls:/dyndebugDomain/serverConfig> tasks=purgeDebugPatchTasks(target='myCluster')

showDebugPatchInfo

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

WLSTでの使用: オンライン

説明

指定されたターゲットのデバッグ・パッチの詳細を表示します。管理サーバーの接続中に、オプションのtargetパラメータを指定して、複数の管理対象サーバーおよびクラスタのデバッグ・パッチ情報を表示できます。表示される情報には、デバッグ・パッチに存在する場合にREADMEファイルの内容とともにデバッグ・パッチの内容が含まれます。

構文

showDebugPatchInfo(patch, [target])

引数	定義
patch	情報を表示するデバッグ・パッチの名前。
target	オプション。管理サーバーのみ。サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。指定しない場合、接続されたサーバーのデバッグ・パッチ情報のみが表示されます。デフォルト値はNoneです。

例

次の例では、クラスタmyClusterにデプロイされているdyndebug01.jarデバッグ・パッチの情報を表示します。

ms1およびms2というラベルの列は、それぞれ管理対象サーバーms1およびms2にデプロイされているdyndebug01.jarデバッグ・パッチの情報を表示します。

wls:/dyndebugDomain/serverConfig> showDebugPatchInfo('dyndebug01.jar', target='myCluster'
ms1:
dyndebug01.jar:
    dyndebug.Class01
    dyndebug.Class02


Additional Information:
Sat Sep 13 14:24:17 EDT 2014

This is additional information for dyndebug01.



ms2:
dyndebug01.jar:
    dyndebug.Class01
    dyndebug.Class02


Additional Information:
Sat Sep 13 14:24:17 EDT 2014

This is additional information for dyndebug01.)

saveDiagnosticImageCaptureFile

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

WLSTでの使用: オンライン

説明

WLSTが現在接続されているサーバーから指定した診断イメージ・キャプチャをダウンロードします。

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

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

構文

saveDiagnosticImageCaptureFile(imageName, [Server], [outputFile], [partition])

引数	定義
imageName	ダウンロードする診断イメージ・キャプチャの名前。
options	Server - 管理サーバーのみ。イメージの取得元となるサーバーの名前。管理サーバーに接続して管理対象サーバーからイメージを取得する際には、適切なServer引数を指定する必要があります。指定しない場合、デフォルトのNoneになります。 outputFile - 取得した診断イメージ・キャプチャを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトでimageNameの値および現在の作業ディレクトリになります。指定しない場合、デフォルトのNoneになります。 partition - イメージを取得するパーティションの名前。

例

次の例では、サーバーのイメージ宛先ディレクトリにある診断イメージ・キャプチャのリストを取得します。saveDiagnosticImageCaptureFileコマンドの2つの使用例を示します。最初の使用例では、リストの最初の診断イメージ・キャプチャがデフォルトの出力ファイル名でローカル・マシンにダウンロードされます。2番目の使用例では、リストの最初の診断イメージ・キャプチャがファイルmylocalimg.zipでローカル・マシンにダウンロードされます。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureFile(images[0])
Retrieving diagnostic_image_myserver_2009_06_25_12_12_50.zip to local 
path diagnostic_image_myserver_2009_06_25_12_12_50.zip
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureFile(images[0], 'mylocalimg.zip')
Retrieving diagnostic_image_myserver_2009_06_25_12_12_50.zip to local 
path mylocalimg.zip
Connecting to http://localhost:7001 with userid weblogic ...

saveDiagnosticImageCaptureEntryFile

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

WLSTでの使用: オンライン

説明

WLSTが現在接続されているサーバーにある診断イメージ・キャプチャから特定のエントリをダウンロードします。

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

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

構文

saveDiagnosticImageCaptureEntryFile(imageName, imageEntryName, [Server], [outputFile], [partition])

引数	定義
imageName	任意のエントリを含む診断イメージ・キャプチャの名前。
imageEntryName	診断イメージ・キャプチャから取得する特定のエントリの名前。これは、次のいずれかです。 image.summary JTA.xml FlightRecording.jfr WatchSource.xml configuration.zip WORK_MANAGER.txt JNDI_IMAGE_SOURCE.xml APPLICATION.xml InstrumentationImageSource.xml SAF.xml Logging.txt PERSISTENT_STORE.xml JDBC.txt PathService.xml JMS.xml Deployment.xml JVM.xml CONNECTOR.xml
outputFile	オプション。診断イメージ・キャプチャから取得したエントリを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトでimageEntryNameの値および現在の作業ディレクトリになります。
options	Server - 管理サーバーのみ。イメージ・エントリの取得元となるサーバー。管理サーバーに接続して管理対象サーバーからイメージ・エントリを取得する際には、適切なServer引数を指定する必要があります。指定しない場合、デフォルトのNoneになります。 outputFile - 診断イメージ・キャプチャから取得したエントリを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトでimageEntryNameの値および現在の作業ディレクトリになります。指定しない場合、デフォルトのNoneになります。 partition - イメージ・エントリを取得するパーティションの名前。

例

次の例では、診断イメージ・キャプチャのリストを取得し、saveDiagnosticImageCaptureEntryFileを2回使用します。最初の使用例では、このコマンドは、デフォルトの出力ファイル名でローカル・マシンにイメージのサマリーを取得します。2番目の使用例では、ファイルmyimage.summaryでローカル・マシンにイメージのサマリーを取得します。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureEntryFile(images[0], 'image.summary')
Retrieving entry image.summary from diagnostic_image_myserver_2009_06_25_12_12_50.zip to local path image.summary
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureEntryFile(images[0], 'image.summary', 'myimage.summary')
Retrieving entry image.summary from diagnostic_image_myserver_2009_06_25_12_12_50.zip to local path myimage.summary
Connecting to http://localhost:7001 with userid weblogic ...

次の例では、診断イメージ・キャプチャのリストを取得し、saveDiagnosticImageCaptureEntryFileコマンドを起動してパーティションp1に対する指定されたエントリを取得します。

wls:/partitionDomain/serverConfig> images = getAvailableCapturedImages(partition='p1')
wls:/partitionDomain/serverConfig> print images
array(java.lang.String,['diagnostic_image__p1_e0774122-58e8-421b-963b-d076096a72cf_partitionAdmin_2015_01_23_12_35_01.zip', 'diagnostic_image__p1_e0774122-58e8-421b-963b-d076096a72cf_partitionAdmin_2015_01_23_12_50_38.zip']) 
wls:/partitionDomain/serverConfig>  saveDiagnosticImageCaptureEntryFile(images[0], 'image.summary', 'myimage.summary', partition='p1')
Retrieving entry image.summary from diagnostic_image__p1_e0774122-58e8-421b-963b-d076096a72cf_partitionAdmin_2015_01_23_12_35_01.zip to local path myimage.summary
Saving diagnostic image entry diagnostic_image__p1_e0774122-58e8-421b-963b-d076096a72cf_partitionAdmin_2015_01_23_12_35_01.zip/image.summary from server image.summary to  for partition myimage.summary

編集コマンド

表3-7に示すWLST編集コマンドを使用して、構成Beanの照会や編集を行います。

注意: 構成Beanを編集するには、管理サーバーに接続している必要があります。また、編集ツリーに移動して、編集セッションを開始する必要があります。「edit」および「startEdit」をそれぞれ参照してください。 管理対象サーバーに接続した場合、WLSTの機能は構成Bean階層の参照だけに制限されます。WLSTを使用して管理対象サーバー上のMBeanの値を変更することはできませんが、管理APIを使用すれば可能です。ただし、管理サーバー上の構成MBeanの値のみを変更することをお薦めします。管理対象サーバー上のMBeanの値を変更すると、ドメイン構成に矛盾が生じる可能性があります。 構成Beanの編集の詳細は、『WebLogic Scripting Toolの理解』のWLSTオンラインを使用した既存ドメインの更新に関する項を参照してください。

表3-7 WLST構成の編集コマンド

コマンド	説明	WLSTの使用...
activate	現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。	オンラインまたはオフライン
assign	リソースを1つまたは複数の宛先に割り当てます。	オフライン
cancelEdit	編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。この操作は、その編集セッションを開始したユーザーでなくても、管理者権限を持つユーザーであれば誰でも呼び出すことができます。	オンライン
create	現在のBeanに対して、指定されたタイプの構成Beanを作成します。	オンラインまたはオフライン
createEditSession	新しい編集セッションを作成します。	オンライン
delete	現在の構成Beanの構成のインスタンスを削除します。	オンラインまたはオフライン
deleteFEHost	ドメインのフロントエンド・ホストを削除します。	オフライン
destroyEditSession	指定された編集セッションを削除します。	オンライン
enableOverwriteComponentChanges	アクティブ化中にすべてのシステム・コンポーネントへの変更を上書きします。	オンライン
encrypt	指定された文字列を暗号化します。	オンライン
get	指定された属性の値を返します。	オンラインまたはオフライン
getActivationTask	ユーザーがステータスを取得できる最新のActivationTask MBeanを返します。	オンライン
invoke	現在の構成Beanの管理操作を呼び出します。	オンライン
isRestartRequired	サーバーの再起動が必要かどうかを判断します。	オンライン
loadDB	SQLファイルをデータベースにロードします。	オフライン
loadProperties	プロパティ値をファイルからロードします。	オンラインまたはオフライン
pullComponentChanges	リモート・ノードからシステム・コンポーネントの構成変更を抽出します。	オンライン
resolve	外部の変更または競合を検出して解決します。	オンライン
resync	指定されたシステム・コンポーネントの構成ファイルを再同期します。	オンライン
resyncAll	すべてのシステム・コンポーネントの構成ファイルを再同期します。	オンライン
save	編集されてまだ保存されていない編集内容を保存します。	オンライン
set	現在の構成Beanの指定された属性値を設定します。	オンラインまたはオフライン
setOption	WebLogicドメインの作成または更新に関連するオプションを設定します。	オフライン
showChanges	現在の編集セッション中に現在のユーザーが行った構成の変更内容を表示します。	オンライン
showComponentChanges	リモート・ノードの指定されたシステム・コンポーネントの構成への変更を表示します。	オンライン
showEditSession	指定された編集セッションの情報を表示します。	オンライン
startEdit	現在接続しているユーザーのために構成編集セッションを開始します。	オンライン
stopEdit	編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。	オンライン
unassign	1つまたは複数の宛先からアプリケーションまたはリソースの割当てを解除します。	オフライン
undo	保存またはアクティブ化されていない編集をすべて元に戻します。	オンライン
validate	変更されてまだ保存されていない変更内容を検証します。	オンライン

activate

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

WLSTでの使用: オンライン

説明

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

異なる名前の複数の編集セッションがシステムに共存する場合があります。名前が付いた編集セッションの変更中に、別の編集セッションのユーザーが同時に構成を変更してそれらの変更をアクティブ化できます。矛盾した変更を防ぐために、システムは各アクティブ化の前に外部構成の変更を確認します。競合していない同時変更は自動的にマージされます。未解決の競合の場合、システムはアクティブ化を終了し、エラーを返します。すべての既存の編集セッションをリストするには、showEditSession()コマンドを使用します。このコマンドの詳細は、「showEditSession」を参照してください。潜在的な変更の競合を解決するには、resolve()コマンドを使用します。このコマンドの詳細は、「resolve」を参照してください。

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

activateを使用する際には、次のようなロック・メカニズムの動作に注意してください。

• 排他的ロックを使用して同じユーザー・アカウントで複数の同時編集セッションを実行する場合、あるセッションでactivate()を使用して変更をアクティブ化すると、そのセッションのロックが解放され、次のセッションがロックを取得できるようになります。したがって、最初のセッションでactivate()の後にcancelEdit()を使用してロックを解放する必要はありません。それを行うと、実際にはキューにある次のセッションの編集セッションが取り消され、例外が発生する可能性があります。

• ロックはドメインに1つしかなく、ロックを保持できるユーザーは常に1人のみです。排他的ロックでないかぎり、そのユーザーは任意の数のセッションからロックを取得できます。各セッションの変更が既存の変更セットに追加されます。いずれかのセッションでactivate()が呼び出されると、すべてのセッションでその時点までに行われた変更がすべてアクティブ化されます。同様に、いずれかのセッションでcancelEdit()が呼び出されると、すべてのセッションでその時点までに行われた変更がすべて取り消され、そのユーザーによってロックが解放されるので、別のユーザーが編集ロックを取得できるようになります。

構文

activate([timeout], [block])

引数	定義
timeout	オプション。操作を取り消す前に、WLSTが構成の変更のアクティブ化が完了するのを待機する時間(ミリ秒単位)。値 -1は、操作がタイムアウトしないことを表します。この引数のデフォルトは300,000ミリ秒(5分)です。
block	オプション。コマンドが完了するまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはfalseで、ユーザー対話がブロックされないことを示します。この場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

例

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

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

assign

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

WLSTでの使用: オフライン

説明

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

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

構文

assign(sourceType, sourceName, destinationType, destinationName)

引数	定義
sourceType	割り当てる構成Beanのタイプ。この値は、次のいずれかの値に設定できます。 AppDeployment Library securityType (Userなど) Server service (JDBCSystemResourceなど) service.SubDeployment。serviceには、SubDeploymentのサービス・タイプを指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。 この値の設定のガイドラインについては次を参照してください。
sourceName	割り当てるリソースの名前。複数の名前をカンマで区切って指定することも、ワイルドカード(*)を使って指定されたタイプのすべてのリソースを指定することも可能です。 サブデプロイメントはservice.subDeploymentという形式で指定します。serviceには親サービス、subDeploymentにはサブデプロイメントの名前を指定します。たとえば、myJMSResource.myQueueSubDeploymentネストされたサブデプロイメントも指定できます(MedRecEAR.MedRecAppScopedJMS.MedRecJMSServerなど)。 注意: assignコマンドがネストされたサブデプロイメントと解釈するため、指定されたサブデプロイメント名でドット(.)を使用できません。
destinationType	宛先のタイプ。この値の設定のガイドラインについては次を参照してください。
destinationName	宛先の名前。複数の名前をカンマで区切って指定できます。 JMSサービスを移行可能な管理対象サーバーに割り当てる場合などに、移行可能なターゲットを指定するには、宛先名の後ろにmigratableと指定します。例: managed1 (migratable)

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')
  

• JMSファイル・ストアmyFileStoreを、managed1という移行可能ターゲットの管理対象サーバーに割り当てます。

  wls:/offline/mydomain>assign('FileStore', 'myFileStore', 'Target',
  'managed1 (migratable)'
  

cancelEdit

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

WLSTでの使用: オンライン

説明

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

このコマンドを発行するユーザーは現在の編集者でなくてもかまいません。つまり、必要な場合は、他のユーザーが編集セッションを開始できるように、管理者が編集セッションを取り消すことができます。

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

cancelEditの追加情報については、activateコマンドを参照してください。

構文

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変数の詳細は、『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サンプル・スクリプトを参照してください(『WebLogic Scripting Toolの理解』のWLSTサンプル・スクリプトに関する項を参照)。

• MBeanとその子タイプ、属性、操作については、Oracle WebLogic Server MBeanリファレンスを参照してください。

構文

create(name, childMBeanType, [baseProviderType])

引数	定義
name	作成する構成Beanの名前。
childMBeanType	作成する構成Beanのタイプ。config.xmlファイルに定義されたタイプのインスタンスを作成できます(カスタム・セキュリティ・タイプは除く)。有効な構成Beanの詳細は、Oracle WebLogic Server MBeanリファレンスを参照してください。
baseProviderType	セキュリティ・プロバイダを作成する場合は、基本セキュリティ・プロバイダ・タイプ(AuthenticationProviderなど)を指定します。この引数のデフォルトはNoneです。

例

次の例では、現在の構成Beanで、newServerという名前のServerタイプの子構成Beanを作成して、スタブをserver1に格納します。

wls:/mydomain/edit !> server1=create('newServer','Server') 
Server with name 'newServer' has been created successfully.
wls:/mydomain/edit !> server1.getName() 
'newServer'
wls:/mydomain/edit !>

次の例では、myProviderという認証セキュリティ・プロバイダを作成します。

wls:/mydomain/edit !> cd('SecurityConfiguration/mydomain/Realms/myrealm') 
wls:/mydomain/edit !> create('myProvider','weblogic.security.providers.authentication.SQLAuthenticator'
,'AuthenticationProvider')
wls:/mydomain/edit ! cd('AuthenticationProviders/myProvider')
wls:/mydomain/edit ! set('ControlFlag', 'REQUIRED')

次の例では、highsec_nmというマシンを作成して、関連するノード・マネージャの属性を設定します。

wls:/mydomain/edit !> create('highsec_nm', 'Machine') 
wls:/mydomain/edit !> cd('Machine/highsec_nm/NodeManager/highsec_nm') 
wls:/mydomain/edit !> set('DebugEnabled', 'true') 
wls:/mydomain/edit !> set('ListenAddress', 'innes') 
wls:/mydomain/edit !> set('NMType', 'SSL') 
wls:/mydomain/edit !> set('ShellCommand', '') 

createEditSession

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

WLSTでの使用: オンライン

説明

指定された名前および説明を使用して、新しい名前が付いた編集セッションを作成します。作成された編集セッションのコンテキストに移動するには、edit(editSessionName)コマンドを使用します。

指定された名前のセッションがすでに存在する場合または指定された編集セッション名に無効な文字が含まれている場合、新しい編集セッションの作成に失敗する可能性があります。

構文

createEditSession(name, [descripton])

引数	定義
name	編集セッションの名前または識別子。英数字、アンダースコア(_)およびダッシュ(-)を使用できます。
descripton	オプション。ユーザーが簡単に識別するための編集セッションの説明。

例

次の例では、mySampleSessionという名前の編集セッションを作成し、作成するセッションの便利な説明を示します。

wls:/wls/serverConfig> createEditSession('mySampleSession', 'This session is created to test this command')

delete

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

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

説明

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

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

注意: 現在の構成管理オブジェクト(cmo)タイプの子である構成Beanのみを削除できます。cmo変数の詳細は、『WebLogic Scripting Toolの理解』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

delete(name, childMBeanType)

引数	定義
name	削除する子構成Beanの名前。
childMBeanType	削除する構成Beanのタイプ。config.xmlファイルで定義されたタイプのインスタンスを削除できます。有効な構成Beanの詳細は、Oracle WebLogic Server MBeanリファレンスを参照してください。

例

次の例では、newServerという名前のServerタイプの構成Beanを削除します。

wls:/mydomain/edit !> delete('newServer','Server') 
Server with name 'newServer' has been deleted successfully.
wls:/mydomain/edit !> 

deleteFEHost

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

WLSTでの使用: オフライン

説明

ドメインのフロントエンド・ホストのプレーンURL、SSL URLおよびデフォルトURLの値をサービス表から削除します。

構文

deleteFEHost()

例

次の例では、ドメインmydomainのドメイン・フロントエンド・ホストのURL値を削除します。

wls:/offline> readDomain("/domains/mydomain")
wls:/offline> deleteFEHost()

destroyEditSession

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

WLSTでの使用: オンライン

説明

指定された編集セッションを削除または破棄します。

デフォルト(名前が付いていない)の編集セッションは削除できません。アクティブ化を保留しているまたは現在アクティブ化中の変更を含む編集セッションはデフォルトで破棄できません。保留中のアクティブ化の変更を含むセッションを破棄する場合または指定された編集セッションの所有者が現在のユーザーと異なる場合、強制フラグをtrueに設定する必要があります。

構文

destroyEditSession(name, [force])

引数	定義
name	削除する編集セッションの名前または識別子。
force	オプション。trueに設定されている場合、保留中のアクティブ化の変更を含むセッションが削除されます。falseに設定されている場合、保留中のアクティブ化の変更を含むセッションが保存され、コマンドは失敗します。この引数のデフォルトはfalseです。

例

次の例では、fourという名前の編集セッションを削除または破棄します。強制フラグは、trueに設定されます。これは指定された編集セッションに保留中のアクティブ化の変更が含まれる場合でもセッションが削除または破棄されることを示します。

wls:/wls/serverConfig> destroyEditSession('four', 'true')

enableOverwriteComponentChanges

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

WLSTでの使用: オンライン

説明

アクティブ化中にすべてのシステム・コンポーネントへの変更を上書きします。このコマンドには、アクティブな編集セッションが必要です。

構文

enableOverwriteComponentChanges()

例

次の例では、アクティブ化中のすべてのシステム・コンポーネントの変更を上書きします。

startEdit()

enableOverwriteComponentChanges()

encrypt

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

WLSTでの使用: オンライン

説明

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

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

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

構文

encrypt(obj, [domainDir])

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

例

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

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

get

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

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

説明

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

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

かわりに、cmo変数を使用して、現在の構成Beanの任意のgetメソッドを実行できます。例:

cmo.getListenPort()

cmo変数の詳細は、『WebLogic Scripting Toolの理解』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

get(attrName)

引数	定義
attrName	表示する属性の名前。属性のフル・パス名を指定できます。パス名を指定しない場合は、現在の構成オブジェクトの属性が表示されます。

例

次の例では、現在の構成BeanのAdministrationPortの値を返します。

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

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

cmo.getAdministrationPort()

getActivationTask

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

WLSTでの使用: オンライン

説明

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

注意: WLSTの外部の変更をアクティブ化している場合、ConfigurationManagerMBean getActivationTasks()メソッドを使用して他のツールで作成したアクティブ化タスクにアクセスします。

構文

getActivationTask()

例

次の例では、ユーザーがステータスを取得できる最新のActivationTask MBeanを返して、task変数に格納します。

wls:/mydomain/edit> task=getActivationTask() 
wls:/mydomain/edit> if task!=None:
...   task.getState()
... 
4

invoke

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

WLSTでの使用: オンライン

説明

現在の構成Beanの管理操作を呼び出します。通常、このコマンドを使用して、ほとんどのWebLogic Server構成Beanで提供されているgetおよびset以外の操作を呼び出します。クラス・オブジェクトは、このアクションが呼び出される構成Beanをロードする際に使用されたものと同じクラス・ローダーから、ロードされます。

WLSTが管理対象サーバー・インスタンスに接続しているときにinvokeコマンドを使用することはできません。

成功した場合、invokeコマンドは、呼び出された操作が返すオブジェクトを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

invoke(methodName, parameters, signatures)

引数	定義
methodName	呼び出すメソッドの名前。
parameters	メソッド呼出しに渡されるパラメータの配列。
signatures	アクションのシグネチャを含む配列。

例

次の例では、現在の構成BeanのlookupServerメソッドを呼び出します。

wls:/mydomain/config> objs = jarray.array([java.lang.String("oamserver")],java.lang.Object) 
wls:/mydomain/edit> strs = jarray.array(["java.lang.String"],java.lang.String) 
wls:/mydomain/edit> invoke('lookupServer',objs,strs) 
true
wls:/mydomain/edit>

isRestartRequired

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

WLSTでの使用: オンライン

説明

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

編集セッションの進行中にこのコマンドを呼び出すと、現在進行中の編集に基づいてレスポンスが行われます。属性の名前を指定した場合は、その属性に関してのみ、サーバーの再起動が必要かどうかが示されます。

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

構文

isRestartRequired([attributeName])

引数	定義
attributeName	オプション。サーバーの再起動が必要かどうかをチェックする特定の属性の名前。

例

次の例では、現在のWLSTセッション中に行われるすべての変更について、サーバーの再起動が必要かどうかが示されます。

wls:/mydomain/edit !> isRestartRequired() 
Server re-start is REQUIRED for the set of changes in progress. 

The following attribute(s) have been changed on MBeans that require server re-start. 
MBean Changed : mydomain:Name=mydomain,Type=Domain 
Attributes changed : AutoConfigurationSaveEnabled 

次の例では、ConsoleEnabled属性を編集する場合にサーバーの再起動が必要かどうかが示されます。

wls:/mydomain/edit !> isRestartRequired("ConsoleEnabled") 
Server re-start is REQUIRED if you change the attribute ConsoleEnabled wls:/mydomain/edit !> 

loadDB

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

WLSTでの使用: オフライン

説明

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

loadDBコマンドは、テンプレート・ファイルからSQLファイルをロードします。このコマンドは、ドメイン・テンプレートまたは拡張テンプレートがメモリーにロードされた後でのみ発行できます(「readDomain」および「readTemplate」を参照)。

このコマンドを実行する前に、次の条件に該当することを確認してください。

• 適切なデータベースが実行されています。

• 指定されたデータベースとバージョンのSQLファイルが存在します。

  適切なSQLファイルが存在することを確認するには、ドメイン・テンプレートを開いて、_jdbc_ディレクトリにある関連するSQLファイル・リストjdbc.indexを見つけます。たとえば、Oracle 9iの場合、SQLファイル・リストは_jdbc_\Oracle\9i\jdbc.indexにあります。

上記の条件が満たされていない場合、コマンドは失敗します。

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

構文

loadDB(dbVersion, datasourceName, dbCategory)

引数	定義
dbVersion	SQLファイルが使用されるデータベースのバージョン。
datasourceName	SQLファイルのロードに使用するJDBCデータ・ソースの名前。
dbCategory	オプション。指定されたデータ・ソースに関連付けられるデータベース・カテゴリ。 jdbc.indexファイルおよびデータベース・カテゴリの詳細は、『Oracle WebLogic Serverドメイン・テンプレート・リファレンス』のテンプレートに含まれるファイルに関する項を参照してください。

例

次の例では、p13nDataSource JDBCデータ・ソースを使用して、データベースのバージョン5.1用のDrop/Create P13N Database Objectsに関連するSQLファイルをロードします。

wls:/offline/mydomain> loadDB('5.1', 'p13nDataSource', 'Drop/Create P13N Database Objects') 

loadProperties

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

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

説明

プロパティ値をファイルからロードして、WLSTセッションで使用できるようにします。

『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、このコマンドは使用できません。

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

構文

loadProperties(fileName)

引数	定義
fileName	プロパティ・ファイルのパス名。

例

この例では、プロパティ・ファイルの値を取得して設定します。

wls:/mydomain/serverConfig> loadProperties('c:/temp/myLoad.properties') 

pullComponentChanges

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

WLSTでの使用: オンライン

説明

リモート・ノードから現在の編集セッションへのシステム・コンポーネントの構成変更を抽出します。このコマンドには、アクティブな編集セッションが必要です。

構文

pullComponentChanges(compName)

引数	定義
compName	構成変更を抽出するシステム・コンポーネントの名前。

例

次の例では、編集セッションを起動し、リモート・ノードから現在の編集セッションへのシステム・コンポーネントotd_test_varunam.in.oracle.comの構成変更を抽出します。次に、変更をアクティブ化します。

startEdit()
 
pullComponentChanges('otd_test_varunam.in.oracle.com')
pull component otd_test_varunam.in.oracle.com changes on machine varunam.in.oracle.com:
add OTD/test/config/foo.conf
edit OTD/test/config/server.xml
edit OTD/test/config/test-obj.conf
remove OTD/test/config/obj.conf
 
activate()

resolve

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

WLSTでの使用: オンライン

説明

現在の編集セッションの一部として行われた変更と外部でアクティブ化される変更の競合を検出します。1つ以上の競合が検出された場合、stopOnConflictsパラメータは、一連の事前に定義されたルールを使用して競合を自動的に解決するか、競合のリストを表示してコマンドの実行を終了するかを決定します。このコマンドは、現在の編集セッションを操作します。このコマンドを使用するには、ユーザーは編集セッション・ロックを取得する必要があります。

すべての競合が解決された後、コマンドは、セッションの作成後またはresolve()への最後の正常な呼出し後に外部で行われた競合していない変更とともに現在の編集セッションを更新します。resolve()コマンドは、現在の編集セッションの内容のみ更新します。編集セッションの保留中の変更はアクティブ化されません。

resolve()コマンドは、検出された競合のリスト、解決操作の説明、resolve()呼出しの一部としてこの編集セッションに適用されたすべての外部変更のリストを常に表示します。

構文

resolve([stopOnConflicts])

引数	定義
stopOnConflicts	オプション。1つ以上の競合が検出された場合に解決を決定するブール・フラグ。falseに設定されている場合、コマンドは競合を自動的に解決しようとします。trueに設定されている場合、コマンドは検出されたすべての競合をリストし、コマンドの実行を終了します。この引数のデフォルトはfalseです。

例

次の例では、検出された競合をリストするresolve()コマンドを呼び出します。競合を説明し、解決操作の説明も示します。

>wls:/wls/edit(one)/Servers/s1 !> resolve()
      1 conflict:
      [1]
      [wls]/Servers[s1] - A conflict in a property ListenPort has been detected.
      Original value: 7001
      Edit value: 8111
      Runtime value: 8222
      Description of resolve operation:
      The changes made to ListenPort by the current edit session will override the ones present in the current runtime configuration.
 
      Patch:
      No difference.

resync

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

WLSTでの使用: オンライン

説明

管理サーバーから対応するリモート・ノードに指定されたシステム・コンポーネントの構成ファイルを再同期します。このコマンドは、編集セッションの外部で呼び出す必要があります。

注意: このコマンドは、再同期中の構成変更の発生を防ぐために編集セッションを自動的に起動します。

構文

resync(compName)

引数	定義
compName	構成ファイルを再同期するシステム・コンポーネントの名前。

例

次の例では、システム・コンポーネントotd_test_varunam.in.oracle.comの構成ファイルの変更を示します。次に、このシステム・コンポーネントの構成ファイルを再同期します。

showComponentChanges('otd_test_varunam.in.oracle.com')
add OTD/test/config/bar.conf 1970.01.01-05:30:00 2014.11.07-17:35:15
edit OTD/test/config/proxyvs.obj.conf 2014.11.07-17:36:49 1970.01.01-05:29:59
edit OTD/test/config/server.xml 2014.11.07-17:36:49 2014.11.07-17:37:22
remove OTD/test/config/test-obj.conf 2014.11.07-17:36:49 1970.01.01-05:30:00
 
resync('otd_test_varunam.in.oracle.com')
 
showComponentChanges('otd_test_varunam.in.oracle.com')
component otd_test_varunam.in.oracle.com changes on machine varunam.in.oracle.com: no change found.

resyncAll

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

WLSTでの使用: オンライン

説明

構文

resyncAll()

例

次の例では、すべてのシステム・コンポーネントの構成変更を示します。次に、すべてのシステム・コンポーネントの構成ファイルを再同期します。

>showComponentChanges()
component otd_test_varunam.in.oracle.com changes on machine varunam.in.oracle.com:
add OTD/test/config/baz.conf 1970.01.01-05:30:00 2014.11.07-17:42:57
component otd_origin-server-1_varunam.in.oracle.com changes on machine varunam.in.oracle.com:
add OTD/origin-server-1/config/bar.conf 1970.01.01-05:30:00 2014.11.07-17:43:34
 
resyncAll()
 
showComponentChanges()
component otd_test_varunam.in.oracle.com changes on machine varunam.in.oracle.com: no change found.
component otd_origin-server-1_varunam.in.oracle.com changes on machine varunam.in.oracle.com: no change found.

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となっている属性)の設定については、『WebLogic Scripting Toolの理解』の暗号化された構成値の読み書きに関する項を参照してください。

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

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

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

• このコマンドのかわりとして、次の構文とともにcmo変数を使用できます。

  cmo.setattrName(value)

  たとえば、set('ListenPort', 7011)を使用するかわりに、次の構文を使用できます。

  cmo.setListenPort(7011)

  cmo変数の詳細は、『WebLogic Scripting Toolの理解』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

set(attrName, value)

引数	定義
attrName	設定する属性の名前。
value	設定する属性の値。 注意: この値は一重または二重の引用符で囲む必要がありません。例を参照してください。

例

次の例では、DomainMBeanのArchiveConfigurationCount属性を10に設定します。

wls:/mydomain/serverConfig> set('ArchiveConfigurationCount', 10) 

次の例では、カスタムMbeanのT1TimerInterval属性のlong値を123に設定しています。

wls:/mydomain/serverConfig> set('T1TimerInterval', Long(123)) 

次の例では、カスタムMbeanのMyBooleanAttribute属性のブール値をtrueに設定しています。

wls:/mydomain/serverConfig> set('MyBooleanAttribute', Boolean(true)) 

setOption

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

WLSTでの使用: オフライン

説明

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

構文

setOption(optionName, optionValue)

引数	定義
optionName	設定するオプションの名前。可能な値については、次の表を参照してください。
optionValue	オプションの値。 注意: ブール値は、文字列(true、false)または整数(0、1)として指定できます。

オプション名	用途	説明
DomainName	ドメインの作成	WebLogicドメインの名前。デフォルトでは、WebLogicドメインの名前はドメイン・ディレクトリの名前から取られます。たとえば、WebLogicドメインがc:/Oracle/Middleware/user_projects/domains/myMedrecに保存される場合、ドメイン名はmyMedrecになります。DomainNameを設定すると、作成されたドメインの名前がドメイン・ディレクトリ名に依存することはなくなります。
JavaHome	ドメインの作成	サーバーの起動時に使用するJVMのホーム・ディレクトリ。このオプションのデフォルトは、WebLogic Serverをインストールしているプラットフォームによって異なります。
NodeManagerType	ドメインの作成	ドメインのノード・マネージャを作成するときに使用するノード・マネージャ・タイプ。このオプションのデフォルトはPerDomainNodeManagerです。 PerDomainNodeManager - このオプションを指定する場合、ノード・マネージャ・ホームはドメインで<domain_name>/nodemanagerとして事前に定義されているため、編集できません。各ドメインのノード・マネージャは、このディレクトリ内のファイルの指定に従って、異なる構成にできます。 CustomLocationNodeManager - ドメインごとのノード・マネージャ構成ファイルを特定の場所に作成する場合は、このオプションを指定します。指定するディレクトリは空である必要があります。 ManualNodeManagerSetup - ノード・マネージャの構成を手動で設定する場合は、このオプションを指定します。選択した場合、ドメインのノード・マネージャ構成は無視されます。既存のノードマネージャ構成に手動で必要な変更を構成する必要があります。 注意: ドメインをアップグレードしてホストごとのノード・マネージャ構成からドメインごとのノード・マネージャ構成に変更する際に、カスタム・スクリプトを使用してWebLogic Server環境を起動および停止する場合、手動でスクリプトを更新してノード・マネージャ・ホームの場所を新しいドメインベースの場所に変更する必要があります。 ノード・マネージャ・タイプの詳細は、『Oracle WebLogic Serverノード・マネージャの管理』のJavaノード・マネージャの構成に関する項を参照してください。 ドメインごとおよびホストごとのノード・マネージャ構成については、『Oracle WebLogic Serverノード・マネージャの管理』のノード・マネージャのデフォルト構成に関する項を参照してください
NodeManagerHome	ドメインの作成	ノード・マネージャ・ホームは、ドメインに作成されるノード・マネージャのディレクトリです。このオプションは、NodeManagerTypeにCustomLocationNodeManagerが指定された場合にのみ使用されます。
OldNodeManagerHome	ドメインの再構成	ドメインの再構成中、ノード・マネージャのアップグレードのために既存の構成が取得されるノード・マネージャ・ホーム・ディレクトリ。このオプションは、ノード・マネージャのアップグレード・タイプがMigrateの場合にのみ適用されます。
NodeManagerUpgradeType	ドメインの再構成	ノード・マネージャのアップグレードはNewまたはMigrateです。 Newの場合、既存のノード・マネージャ構成は使用されず、指定したタイプのノード・マネージャが作成されます。 Migrateの場合、OldNodeManagerHomeオプションで指定したノード・マネージャ・ホームからノード・マネージャ構成が移行されます。このオプションは、ノード・マネージャ・タイプがPerDomainNodeManagerまたはCustomLocationNodeManagerの場合に、ドメインの再構成中にノード・マネージャをアップグレードするために使用します。
NodeManagerUpgradeOverwriteDefault	ドメインの再構成	必須のノード・マネージャ構成用のオラクル社推奨デフォルト値を上書きするために使用されるブール・フラグ。このオプションは、ノード・マネージャのアップグレード・タイプがMigrateの場合にのみ使用されます。デフォルト値はfalseです。
OverwriteDomain	ドメインの作成	既存のWebLogicドメインを上書き可能にするかどうかを指定するブール値。このオプションのデフォルトはfalseです。
ServerStartMode	ドメインの作成	新規作成したWebLogicドメインでサーバーを起動するときに使用するモード。この値は、dev (開発)またはprod (本番)に設定できます。このオプションのデフォルトはdevです。
AllowCasualUpdate	ドメインのアップグレード	拡張テンプレートを追加せずにWebLogicドメインを更新できるようにするかどうかを指定するブール値。このオプションのデフォルトはtrueです。
ReplaceDuplicates	ドメインのアップグレード	競合があった場合に、WebLogicドメインの元の構成の要素を保持するか、拡張テンプレートの対応する要素で置き換えるかを指定するブール値。このオプションのデフォルトはtrueです。
AppDir	ドメインの作成とドメインのアップグレード	アプリケーションに別のディレクトリが必要な場合に、テンプレートの指定に従って使用されるアプリケーション・ディレクトリ。このオプションのデフォルトは、WL_HOME/user_projects/applications/domainnameになります。WL_HOMEはWebLogic Serverホーム・ディレクトリ、domainnameはWebLogicドメインの名前を表します。
AutoAdjustSubDeploymentTarget	ドメインの作成とドメインのアップグレード	AppDeploymentsのサブデプロイメントのターゲットをWLSTが自動的に調整するかどうかを指定するブール値。このオプションのデフォルトはtrueです。この機能を無効にするには、オプションをfalseに設定して、WebLogicドメインまたはドメイン・テンプレートを書き込むか更新する前に、AppDeploymentのサブデプロイメントの対象を明示的に設定します。
AutoDeploy	ドメインの作成とドメインのアップグレード	クラスタまたは複数の管理対象サーバーを作成するときに、自動デプロイメントをアクティブにするかどうかを指定するブール値。このオプションのデフォルトはtrueです。この機能を無効にするには、スクリプトの最初の行でこのオプションをfalseに設定します。

例

次の例では、AutoDeployオプションをfalseに設定します。

wls:/offline> setOption('AutoDeploy', '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

showComponentChanges

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

WLSTでの使用: オンライン

説明

管理サーバーと比較してリモート・ノードの指定されたシステム・コンポーネントの構成の変更を表示します。

構文

showComponentChanges([compName])

引数	定義
compName	オプション。構成変更を比較するシステム・コンポーネントの名前。指定しない場合、比較がドメイン内のすべてのシステム・コンポーネントに対して実行されます。

例

次の例では、現在のドメイン内のすべてのシステム・コンポーネントの構成変更を示します。

showComponentChanges()
component otd_test_varunam.in.oracle.com changes on machine varunam.in.oracle.com: no change found.
component otd_origin-server-1_varunam.in.oracle.com changes on machine varunam.in.oracle.com: no change found.
component otd_origin-server-2_varunam.in.oracle.com changes on machine varunam.in.oracle.com: no change found.
component otd_origin-server-3_varunam.in.oracle.com changes on machine varunam.in.oracle.com: no change found.

次の例では、システム・コンポーネントotd_test_varunam.in.oracle.comの構成変更を示します。

showComponentChanges('otd_test_varunam.in.oracle.com')
add OTD/test/config/foo.conf 1970.01.01-05:30:00 2014.11.07-17:06:30
edit OTD/test/config/server.xml 2014.11.06-19:48:15 2014.11.07-17:06:08
edit OTD/test/config/test-obj.conf 2014.11.06-16:59:32 1970.01.01-05:29:59
remove OTD/test/config/obj.conf 2014.11.06-19:48:15 1970.01.01-05:30:00

showEditSession

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

WLSTでの使用: オンライン

説明

指定された編集セッションの情報を表示します。編集セッションの名前を指定せずにこのコマンドを起動すると、すべての既存の編集セッションのリストが表示されます。単一の編集セッションの名前がパラメータとして指定される場合、編集セッションの詳細情報が表示されます。

編集セッションの詳細には、次の情報が含まれます。

• 作成者 - 編集セッションを作成したユーザーの名前。

• 編集者 - 編集セッション・ロックを現在所有しているユーザーの名前

• 解決推奨 - yesに設定すると、このフラグは別の編集セッションの構成変更がアクティブ化されたことを示し、この編集セッションの構成スナップショットをそれに準じて非推奨にできます。resolve()コマンドを使用して、最新の実行時構成との一致または変更の競合の解決あるいはその両方を実現するようにセッションの内容を更新します。

• アクティブ化されていない変更を含む - 指定された編集セッションにまだアクティブ化されていない構成変更が含まれているかどうかの情報を提供します。

デフォルトの編集セッションの詳細情報にアクセスするには、入力パラメータとしてdefaultを指定する必要があります。

構文

showEditSession([name])

引数	定義
name	オプション。詳細情報を表示する編集セッションの名前または識別子。この引数を指定しない場合、すべての既存の編集セッションのリストが表示されます。

例

次の例では、引数を指定せずにshowEditSessionコマンドを呼び出します。この例では、すべての編集セッションのリストが表示されます。

wls:/wls/edit> showEditSession()
List of named edit sessions [for details use showEditSession(name)]:
default
one
two
three

次の例では、twoは引数として渡される編集セッションの名前です。結果として、指定された編集セッションの詳細情報が表示されます。

wls:/wls/edit> showEditSession('two')
 
two
Creator: wls
Editor (lock owner): wls
Resolve recommended: No
Contains unactivated changes: Yes

startEdit

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

WLSTでの使用: オンライン

説明

現在接続しているユーザーのために構成編集セッションを開始します。このコマンドを発行する前に、editコマンドを使用して構成MBean階層に移動する必要があります。詳細は、「edit」を参照してください。

WebLogicドメイン構成を変更するコマンドを呼び出す前に、このコマンドを呼び出す必要があります。

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

注意: 同じユーザーによる進行中の編集セッションがあることを検出した場合、WLSTは自動的に編集セッションを開始します。進行中のセッションはWebLogic Server管理コンソールまたは別のWLSTセッションから開始された可能性があります。

構文

startEdit([waitTimeInMillis], [timeoutInMillis], [exclusive])

引数	定義
waitTimeInMillis	オプション。別のユーザーがロックを保持している場合に、WLSTがロックを取得するまでに待機する時間(ミリ秒単位)。この引数のデフォルトは0ミリ秒です。
timeOutInMillis	オプション。WLSTが編集ロックの解放を待機するタイムアウト(ミリ秒単位)。この引数のデフォルトは -1ミリ秒で、この編集セッションが期限切れにならないことを表します。
exclusive	オプション。編集セッションを排他的なセッションにするかどうかを指定します。trueに設定した場合、同じ所有者がstartEditコマンドを入力すると、WLSTは新しい編集セッションを開始する前に、現在の編集セッションのロックが解放されるまで待機します。排他的なロックはtimeoutInMillisで指定された時間に従ってタイムアウトします。この引数のデフォルトはfalseです。

例

次の例は、ロック待機タイムアウトが1分、編集ロック解放待機タイムアウトが2分の設定で、編集セッションを開始します。

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()では、別のユーザーの編集セッションを取り消すことや、他のセッション経由で取得された排他的な編集セッションを停止することはできません。stopEdit()で可能なのは、同じユーザーの排他的でない編集セッションを停止することのみです。

構文

stopEdit([defaultAnswer])

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

例

次の例では、現在の編集セッションを停止します。WLSTは取り消す前に確認を求めます。

wls:/mydomain/edit !> stopEdit() 
Sure you would like to stop your edit session? (y/n)
y 
Edit session has been stopped successfully.
wls:/mydomain/edit>

unassign

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

WLSTでの使用: オフライン

説明

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

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

構文

unassign(sourceType, sourceName, destinationType, destinationName)

引数	定義
sourceType	割当て解除する構成Beanのタイプ。この値は、次のいずれかの値に設定できます。 AppDeployment Library securityType(Userなど) Server service(JDBCSystemResourceなど) service.SubDeployment。serviceには、SubDeploymentのサービス・タイプを指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。
sourceName	割当てを解除するアプリケーションまたはリソースの名前。複数の名前をカンマで区切って指定することも、ワイルドカード(*)を使って指定されたタイプのすべてのリソースを指定することも可能です。 サブデプロイメントはservice.subDeploymentという形式で指定します。serviceには親サービス、subDeploymentにはサブデプロイメントの名前を指定します。たとえば、myJMSResource.myQueueSubDeployment。ネストされたサブデプロイメントも指定できます(MedRecEAR.MedRecAppScopedJMS.MedRecJMSServerなど)。
destinationType	宛先のタイプ。この値の設定のガイドラインについては次を参照してください。
destinationName	宛先の名前。複数の名前をカンマで区切って指定できます。

sourceTypeおよびdestinationTypeの設定では次のガイドラインを使用してください。

• アプリケーション・デプロイメントを割当て解除するときは、次のように値を設定します。

  • sourceType: AppDeployment

  • destinationType: Target

• ライブラリを割当て解除するときは、次のように値を設定します。

  • sourceType: Library

  • destinationType: Target

• セキュリティ・タイプを割当て解除するときは、次のように値を設定します。

  • sourceType: 特定のセキュリティ・タイプの名前(Userなど)

  • destinationType: 宛先のセキュリティ・タイプの名前(Groupなど)

• クラスタからサーバーを割当て解除するときは、次のように値を設定します。

  • sourceType: Server

  • destinationType: Cluster

• サービスを割当て解除するときは、次のように値を設定します。

  • sourceType: 特定のサーバーの名前(JDBCSystemResourceなど)

  • destinationType: Target

• サブデプロイメントを割当て解除するときは、次のように値を設定します。

  • sourceType: service.SubDeployment。serviceにはSubDeploymentの親を指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。

  • destinationType: Target

例

例:

• myServerとmyServer2をクラスタmyClusterから割当て解除します。

  wls:/offline/medrec> unassign("Server", "myServer,myServer2", "Cluster", "myCluster") 
  

• すべてのサーバーをクラスタmyClusterから割当て解除します。

  wls:/offline/mydomain> unassign("Server", "*", "Cluster", "myCluster") 
  

• ユーザーnewUserをグループMonitorsから割当て解除します。

  wls:/offline/medrec> unassign("User", "newUser", "Group", "Monitors") 
  

• アプリケーション・デプロイメントmyAppDeploymentをターゲット・サーバーnewServerから割当て解除します。

  wls:/offline/mydomain> unassign("AppDeployment", "myAppDeployment", "Target", "newServer") 
  

• ネストされたサブデプロイメントMedRecAppScopedJMS.MedRecJMSServer (アプリケーション・デプロイメントAppDeploymentの子)をターゲット・サーバーAdminServerから割当て解除します。

  wls:/offline/mydomain> assign('AppDeployment.SubDeployment.SubDeployment',
  'MedRecEAR.MedRecAppScopedJMS.MedRecJMSServer', 'Target','AdminServer') 
  

undo

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

WLSTでの使用: オンライン

説明

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

(ディスクに保存されたものも含めて)アクティブ化されていないすべての編集を元に戻すか、または、最後のsave操作以降に行われたすべての編集を元に戻すかを指定します。このコマンドでは編集セッションは解放されません。

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

構文

undo([unactivatedChanges], [defaultAnswer])

引数	定義
unactivatedChanges	オプション。ディスクに保存された編集内容も含めて、アクティブ化されていないすべての変更を元に戻すかどうかを指定するブール値。この引数のデフォルトはfalseで、最後のsave操作以降に行われたすべての編集を元に戻すことを表します。
defaultAnswer	オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

例

次の例では、最後のsave操作以降に行われたすべての変更を元に戻します。WLSTは元に戻す前に確認を求めます。

wls:/mydomain/edit !> undo() 
Sure you would like to undo your changes? (y/n)
y 
Discarded your in-memory changes successfully.
wls:/mydomain/edit>

次の例では、アクティブ化されていないすべての変更を元に戻します。WLSTは元に戻す前に確認を求めます。

wls:/mydomain/edit !> undo('true') 
Sure you would like to undo your changes? (y/n)
y 
Discarded all your changes successfully.
wls:/mydomain/edit>

validate

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

WLSTでの使用: オンライン

説明

変更されてまだ保存されていない変更内容を検証します。このコマンドを使用すると、保存する前に、すべての変更が有効かどうかを検証することができます。

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

構文

validate()

例

次の例では、変更されてまだ保存されていないすべての変更内容を検証します。

wls:/mydomain/edit !> validate() 
Validating changes ...
Validated the changes successfully

情報コマンド

表3-8に示すWLST情報コマンドを使用して、ドメイン、サーバー、変数に照会したり、構成Bean、実行時Bean、WLSTに関連した情報を提供したりします。

表3-8 WLST構成の情報コマンド

コマンド	説明	WLSTの使用...
addListener	指定されたMBeanにJMXリスナーを追加します。	オンライン
configToScript	既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します	オンラインまたはオフライン
dumpStack	WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。	オンラインまたはオフライン
dumpVariables	WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。	オンラインまたはオフライン
find	現在の階層内でMBeanと属性を検索します。	オンライン
getConfigManager	変更プロセスを管理している最新のConfigurationManagerBean MBeanを返します。	オンライン
getMBean	指定されたパスを参照してMBeanを返します。	オンライン
getMBI	指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。	オンライン
getPath	指定されたMBeanインスタンスのMBeanパスを返します。	オンライン
listChildTypes	cmoタイプで作成または削除できるすべての子MBeanを表示します。	オンライン
lookup	指定されたMBeanをルックアップします。	オンライン
ls	現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。	オンラインまたはオフライン
man	現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。	オンライン
redirect	WLST出力を指定されたファイル名にリダイレクトします。	オンライン
removeListener	以前に定義したリスナーを削除します。	オンライン
setShowLSResult	ls()が標準出力への出力を記録するかどうかを指定します。	オンラインまたはオフライン
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スクリプトに変換します。その結果得られたスクリプトは、他のサーバー上のリソースの再作成に使用できます。

注意: WebLogic Serverに加えて他のFusion Middlewareコンポーネントを含むドメインにconfigToScriptを使用する場合、configToScriptは作成されたWLSTスクリプトの中にこれらのコンポーネントの構成を含まないことに注意してください。スクリプトに含まれるのはWebLogic Server構成のみです。 ドメインをリモート・サーバー上に作成する場合はpackおよびunpackを使用することを強くお薦めします。packおよびunpackコマンドを使用したドメインの作成を参照してください。

configToScriptコマンドでは次のファイルが作成されます。

• 構成の再作成に必要なコマンドが格納されているWLSTスクリプト。

• ドメイン固有の値が格納されているプロパティ・ファイル。このファイルの値を更新すると、元の構成に似た新しいドメインを作成することができます。

• 暗号化された属性を格納するユーザー構成ファイルおよび関連キー・ファイル。ユーザー構成ファイルには暗号化された情報が格納されます。キー・ファイルには、情報の暗号化と復号化に使用される秘密鍵が格納されます。

生成されたスクリプトを実行すると、次の処理が行われます。

• サーバーが現在実行中であれば、WLSTはプロパティ・ファイル内の値を使用して接続を確立し、次にスクリプト・コマンドを実行して、サーバー・リソースを作成しようとします。

• 現在実行されているサーバーがなければ、WLSTはプロパティ・ファイル内の値でサーバーを起動し、スクリプト・コマンドを実行してサーバー・リソースを作成し、サーバーを停止します。これにより、WLSTがコマンド・シェルを終了させることがあります。

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

構文

configToScript([configPath], [pyPath], [overwrite], [propertiesFile], [createDeploymentScript])

引数	定義
configPath	オプション。変換する構成が格納されたdomainディレクトリのパス。この引数のデフォルトは、WLSTの起動元ディレクトリ(./)です。
pyPath	オプション。変換後のWLSTスクリプトを書き込むパスとファイル名。この引数のデフォルトは/config/config.pyです。
overwrite	オプション。スクリプト・ファイルがすでに存在する場合、そのファイルを上書きするかどうかを指定するブール値。この引数のデフォルトはtrueで、スクリプト・ファイルは上書きされます。
propertiesFile	オプション。WLSTがプロパティ・ファイルを書き込むパスとディレクトリ。この引数のデフォルトは、scriptPath引数で指定されたパス名です。
createDeploymentScript	オプション。WLSTがデプロイメントのみを実行するスクリプトを作成するかどうかを指定するブール値。この引数のデフォルトはfalseで、デプロイメント・スクリプトが作成されないことを表します。

例

次の例では、構成をWLSTスクリプトconfig.pyに変換します。デフォルトで、構成ファイルは./configからロードされて、スクリプト・ファイルは.config/config.pyに、プロパティ・ファイルは.config/config.py.propertiesに保存されます。

wls:/offline> configToScript() 
configToScript is loading configuration from c:\Oracle\Middleware
\user_projects\domains\wls\config\config.xml ...
Completed configuration load, now converting resources to wlst script...
configToScript completed successfully
The WLST script is written to c:\Oracle\Middleware
\user_projects\domains\wls\config\config.py
and the properties file associated with this script is written to c:\Oracle\
Middleware\user_projects\domains\wls\config\config.py.properties
wls:/offline>

次の例では、ファイルc:\Oracle\Middleware\user_projects\domains\mydomain\configディレクトリで構成されたサーバー・リソースをWLSTスクリプトc:\Oracle\Middleware\myscripts\config.pyに変換します。

wls:/offline> configToScript('c:/Oracle/Middleware/user_projects/domains
/mydomain','c:/Oracle/Middleware/myscripts') 
configToScript is loading configuration from c:\Oracle\Middleware
\user_projects\domains\mydomain\config\config.xml ...
Completed configuration load, now converting resources to wlst script...
configToScript completed successfully
The WLST script is written to c:\Oracle\Middleware\myscripts\config.py
and the properties file associated with this script is written to 
c:\Oracle\Middlware\mydomain\config.py.properties
wls:/offline>

dumpStack

コマンド・カテゴリ: 情報コマンド

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

説明

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

成功した場合、dumpstackコマンドはThrowableオブジェクトを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

dumpStack()

例

この例ではスタック・トレースを表示します。

wls:/myserver/serverConfig> dumpStack() 
com.bea.plateng.domain.script.jython.WLSTException: java.lang.reflect.Invocation TargetException
...

dumpVariables

コマンド・カテゴリ: 情報コマンド

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

説明

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

dumpVariables()

例

この例では、現在のすべての変数とその値を表示します。

wls:/mydomain/serverConfig> dumpVariables() 
adminHome   weblogic.rmi.internal.BasicRemoteRef - hostID: 
   '-1 108080150904263937S:localhost:[7001,8001,-1,-1,-1,-1,-1]:
   mydomain:AdminServer', oid: '259', channel: 'null'
cmgr   [MBeanServerInvocationHandler]com.bea:Name=ConfigurationManager,
   Type=weblogic.management.mbeanservers.edit.ConfigurationManagerMBean
cmo   [MBeanServerInvocationHandler]com.bea:Name=mydomain,Type=Domain
connected true
domainName mydomain
...
wls:/mydomain/serverConfig>

find

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

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

WLSTは、属性または属性タイプとその値を格納するMBeanのパス名を返します。searchInstancesOnlyをfalseに設定した場合は、サーバーでインスタンス化されていないものの、作成が可能なMBeanTypeパスの検索も行います。エラーが発生した場合は、WLSTExceptionが返されます。

構文

find([name], [type], [searchInstancesOnly])

引数	定義
name	オプション。検索する属性の名前。
type	オプション。検索する属性のタイプ。
searchInstancesOnly	オプション。登録されたインスタンスのみを検索するか、または、サーバーでインスタンス化されていないものの、作成が可能なMBeanTypesパスも検索するかどうかを指定するブール値。この引数のデフォルトはtrueで、登録されたインスタンスのみが検索されます。

例

次の例では、現在の構成階層でjavaCompilerという属性を検索します。

wls:/mydomain/serverConfig> find(name = 'JavaCompiler') 
Finding 'JavaCompiler' in all registered MBean instances ...
/Servers/AdminServer                         JavaCompilerPreClassPath      null
/Servers/AdminServer                       JavaCompiler                  java
/Servers/AdminServer                      JavaCompilerPostClassPath   null
wls:/mydomain/serverConfig>

次の例では、現在の構成階層でJMSRuntimeタイプの属性を検索します。

wls:/mydomain/serverRuntime> find(type='JMSRuntime') 
Finding MBean of type 'JMSRuntime' in all the instances ...
/JMSRuntime/AdminServer.jms
wls:/mydomain/serverRuntime>

次の例では、現在の構成階層でexecuteという属性を検索します。searchInstancesOnly引数はfalseに設定されており、サーバーでインスタンス化されていないMBeanTypeも検索することを示しています。

wls:/mydomain/serverConfig> find(name='execute', searchInstancesOnly='false') 
Finding 'execute' in all registered MBean instances ...
/Servers/AdminServer      ExecuteQueues [Ljavax.management.ObjectName;@1aa7dbc
/Servers/AdminServer       Use81StyleExecuteQueues                       false
Now finding 'execute' in all MBean Types that can be instantiated ...
/Servers                                      ExecuteQueues
/Servers                                      Use81StyleExecuteQueues
wls:/mydomain/serverConfig>

getConfigManager

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

変更プロセスを管理している最新のConfigurationManager MBeanを返します。そのメソッドを呼び出して、WebLogicドメイン内の構成の変更を管理できます。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getConfigManager()

例

次の例では、最新のConfigurationManagerBean MBeanを返して、cm変数に格納します。

wls:/mydomain/serverConfig> cm=getConfigManager() 
wls:/mydomain/serverConfig> cm.getType() 
'weblogic.management.mbeanservers.edit.ConfigurationManagerMBean'

getMBean

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

指定されたパスを参照してMBeanを返します。エラーが発生した場合は、WLSTExceptionが返されます。

注意: MBeanが見つからない場合に例外はスローされません。

構文

getMBean(mbeanPath)

引数	定義
mbeanPath	現在の階層内のMBeanのパス名。

例

次の例では、パスで指定されたMBeanを返します。

wls:/mydomain/edit !> com=getMBean('Servers/myserver/COM/myserver') 
wls:/mydomain/edit !> com.getType() 
'Server'

getMBI

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getMBI([mbeanType])

引数	定義
mbeanType	オプション。MBeanInfoを表示するMBeanType。

例

次の例では、指定されたMBeanTypeのMBeanInfoを取得して、svrMbi変数に格納します。

wls:/mydomain/serverConfig> svrMbi=getMBI('weblogic.management.configuration.ServerMBean') 

getPath

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

現在のツリーで、指定されたMBeanインスタンスのMBeanパスまたはMBeanのObjectNameを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getPath(mbean)

引数	定義
mbean	MBeanパスを返す、現在のツリー内のMBeanのMBeanインスタンスまたはObjectName。

例

次の例では、パスで指定されたMBeanを返します。

wls:/mydomain/edit !> path=getPath('com.bea:Name=myserver,Type=Server') 
wls:/mydomain/edit !> print path 
'Servers/myserver'

listChildTypes

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

cmoで作成または削除できる子MBeanをすべて表示します。cmo変数は、WLSTを使用して最後に移動した構成Beanインスタンスを表します。cmo変数の詳細は、『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での使用: オンラインまたはオフライン

説明

現在の構成Beanまたは実行時Beanの子Beanと属性をすべて表示します。必要に応じて引数を指定することにより、出力を制御できます。引数を指定しない場合は、ドメイン内の子Beanと属性がすべて表示されます。出力は文字列で返されます。

注意: WLSTオフラインでは、構成ファイルにのみ存在する構成オブジェクトへのアクセスと更新が可能になるため、XML要素としてまだ構成ファイルに永続化されていない構成オブジェクトの属性値を表示または変更する必要がある場合は、まずその構成オブジェクトを作成する必要があります。 WLSTオンラインでは、パフォーマンス上の理由で子Beanがキャッシュされるため、現在のBeanで最初にls()が発行された後、別プロセスで作成された子Beanは、ls()を実行しても返されない場合があります。特定の子Beanが見当たらない場合は、親ディレクトリにcdしてから、キャッシュを再度リフレッシュしてください。

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

デフォルトでは、出力は文字列として返され、3つの列に配置されます。

注意: ls()関数は、デフォルトで、WLSTを実行しているコンソールに出力が表示されるようにエコーします。WLSTスクリプトに次のコマンドを含めることで、これを無効にできます。 WLS.setShowLSResult(flag) flagはブール値です。0 (false)の場合は、ls()からの標準出力への出力は無効になり、コンソールに表示されなくなります。1 (true)に設定した場合は、ls()から標準出力への出力は有効になります。

• 1列目には、リストされた項目を説明する一連のコードが表示されます。表3-9を参照してください。

• 2列目には、項目の名前が表示されます。

• 項目が属性である場合、3列目には、その属性値が表示されます。属性が暗号化されている場合、3列目には、値のかわりにアスタリスクが表示されます。(『WebLogic Scripting Toolの理解』の暗号化された構成値の読み書きに関する項を参照してください。)

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

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

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

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

注意: パフォーマンスを最適化するため、WLSTオフラインを使用する場合、WebLogic Serverのデフォルト値のほとんどは、WebLogicドメインの構成ファイルには格納されません。この最適化が原因で、WLSTオフラインでは管理オブジェクト全体を表示できない場合があります(WebLogic Serverでは対応するXML要素をドメインの構成ファイルに書き込んでいないため)。たとえば、ドメインがアクティブであるときにWebLogicドメインのロギングのデフォルト重大度を変更しなかった場合、WLSTオフラインではドメインのLog管理オブジェクトは表示されません。 WLSTオフラインで表示されない管理オブジェクトの属性のデフォルト値を変更する場合、最初にcreateコマンドを使用して管理オブジェクトを作成する必要があります。次に、cdを使用して管理オブジェクトに移動し、属性値を変更します。「create」を参照してください。

構文

ls( [ a | c | o ] [ moPath ])

ls( [ moPath ] [returnMap] [ returnType ] [inheritance])

引数	定義
a	オプション。指定した管理オブジェクトの属性のみ表示します(他の項目の表示は抑制されます)。
c	オプション。指定した管理オブジェクトの子の管理オブジェクトのみ表示します(他の項目の表示は抑制されます)。
o	オプション。指定した管理オブジェクトで呼出し可能な操作のみ表示します(他の項目の表示は抑制されます)。 この引数は、WLSTオンラインにのみ適用できます。
moPath	オプション。リストする属性、操作、および子の管理オブジェクトの管理オブジェクトへのパス名。 階層の現在の場所に対して相対的なパス名を指定することも、絶対パス名を指定することも可能です。 WLSTオフラインでは、フォワード・スラッシュ(/)を使用して構成ドキュメントのルートを指定します。 WLSTオンラインでは、任意の管理階層のMBeanの内容をリストできます(「ツリー・コマンド」を参照)。次の構文を使用して、階層のルートを指定してください。 root-name:/ たとえば、サーバーの実行時階層のルートを示す例を次に示します。 ls('serverRuntime:/') この引数を指定しない場合、現在の管理オブジェクトの項目がリストされます。
returnMap	オプション。コマンドで値をマップとして返すかどうかを指定するブール値。この引数のデフォルトはfalseです(コマンドでは文字列が返されます)です。
returnType	オプション。マップで返される出力を制御します。この表の冒頭で説明した、出力をフィルタリングするa、c、またはoを指定します。 この引数は、returnMapがtrueに設定されている場合にのみ有効です。この引数のデフォルトはcです。
inheritance	オプション。各属性値の継承情報を含めるかどうかを指定するブール値。指定した場合は、サーバー・テンプレートから継承された属性値がわかるように、後ろに(Inherited)という接尾辞が付けられます。この引数のデフォルトはfalseです。これは、WLSTオンライン・モードの場合にのみ使用できます。 サーバー・テンプレートの詳細は、『Oracle WebLogic Serverドメイン構成の理解』のサーバー・テンプレートに関する項を参照してください。

例

次の例では、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>

次のコマンドは、サーバーserver1に対するls()の出力を示しています。この出力では、定義されたサーバー・テンプレートからRestartIntervalSeconds属性とRestartMax属性が継承されています。

wls:/domain1/serverConfig/Servers> ls('new_ManagedServer_1','true','a','true')

-r--   AcceptBacklog                                300
.
.
.
-r--   RestartIntervalSeconds (Inherited)           3000
-r--   RestartMax (Inherited)                          5
.
.
.
-r--   XMLRegistry                                  null
 
wls:/domain1/serverConfig/Servers> 

man

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

man([a | c | o | attrName])

引数	定義
a	オプション。現在のMBeanのすべての属性のヘルプを表示します。
c	オプション。現在のMBeanに含まれるすべての子構成Beanのヘルプを表示します。
o	オプション。現在のMBeanに対して実行できるすべての操作のヘルプを表示します。
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") 

setShowLSResult

コマンド・カテゴリ: 情報コマンド

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

説明

このコマンドを設定して、ls()関数が標準出力またはコンソールへの出力を記録するかどうかを指定します。ls()から標準出力への出力を無効にするには、値をfalseに設定します。ls()から標準出力への出力を有効にするには、値をtrueに設定します。

構文

setShowLSResult()

引数	定義
showResult	ブール値。falseに設定されている場合、ls()から標準出力への出力が無効になります。trueに設定した場合は、ls()から標準出力への出力は有効になります。

例

次の例では、オフライン・モードのls()から標準出力への出力を無効にします。

wls:/offline/base_domain> setShowLSResult(false)
wls:/offline/base_domain> ls()

次の例では、ls()によるオンライン・モードの標準出力への出力を有効にします。

wls:/base_domain/serverConfig> setShowLSResult(true)
wls:/base_domain/serverConfig> ls()
dr--   AdminConsole

showListeners

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

現在定義されているすべてのリスナーを表示します。リスナーの設定の詳細は、「addListener」を参照してください。

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

構文

showListeners()

例

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

wls:/mydomain/serverConfig> showListeners() 

startRecording

コマンド・カテゴリ: 情報コマンド

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

説明

WLSTとユーザーのすべての対話を記録します。このコマンドは、再試行するコマンドの捕捉に役立ちます。

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

『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、このコマンドは使用できません。

構文

startRecording(recordFile, [recordAll])

引数	定義
recordFile	WLSTコマンドを記録するファイルの名前。ファイル名は、絶対パスでも、WLSTを呼び出したディレクトリを基準とする相対パスでもかまいません。
recordAll	オプション。すべてのユーザー対話をファイルに捕捉するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合はWLSTコマンドのみが捕捉され、WLST以外のコマンド出力は捕捉されません。

例

次の例では、record.pyファイルにWLSTコマンドの記録を開始します。

wls:/mydomain/serverConfig> startRecording('c:/myScripts/record.py') 
Starting recording to c:/myScripts/record.py
wls:/mydomain/serverConfig>

state

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

ノード・マネージャを使用して、サーバー、クラスタまたはシステム・コンポーネントとその状態のマップを返します。ノード・マネージャが動作している必要があります。

サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』のサーバーのライフサイクルの理解に関する項を参照してください。

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

構文

state(name, [type], [returnMap])

引数	定義
name	現在の状態を取得するサーバー、クラスタまたはシステム・コンポーネントの名前。
type	オプション。タイプは、Server、ClusterまたはSystemComponentです。指定しない場合は、指定された名前のサーバー、クラスタまたはシステム・コンポーネントが検索されます。
returnMap	オプション。戻り値を含むマップを返すかどうかを指定するブール値。returnMapがtrueの場合、stateコマンドはすべての状態のマップを返します。デフォルトはfalseです。

例

次の例では、管理対象サーバーmanaged1の状態を返します。

wls:/mydomain/serverConfig> state('managed1','Server') 
Current state of "managed1": SUSPENDED 
wls:/mydomain/serverConfig>

次の例では、クラスタmyclusterの状態を返します。オプションのtype引数は指定されていません。

wls:/mydomain/serverConfig> state('mycluster') 
There are 3 server(s) in cluster: mycluster

States of the servers are
MServer1---SHUTDOWN
MServer2---SHUTDOWN
MServer3---SHUTDOWN
wls:/mydomain/serverConfig>

次の例では、returnMapがfalseに設定されている場合に、標準出力に出力される戻りマップを示します。

wls:/mydomain/serverConfig> retMap=state('managed1')
Current state of "managed1": SUSPENDED 
wls:/mydomain/serverConfig> print retMap
None

次の例では、returnMapがtrueに設定されている場合に、標準出力に出力される戻りマップを示します。

wls:/mydomain/serverConfig> retMap=state('managed1', returnMap='true')
Current state of "managed1": SUSPENDED 
wls:/mydomain/serverConfig> print retMap
[managed1=SUSPENDED}

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はオペレーティング・システムへのログインに使用したユーザー名です。 username-WebLogicConfig.properties また、ファイルを作成した場所が標準出力に出力されます。
userKeyFile	オプション。指定するユーザー構成ファイルに関連付けられているキー情報を格納するファイルの名前。パス名は、絶対パスでも、WLSTを起動したファイル・システムのディレクトリを基準とする相対パスでもかまいません。 この引数を指定しない場合、ファイルは、現在のJVMで決定されるホーム・ディレクトリに格納されます。ホーム・ディレクトリの場所は、WLSTが実行されているオペレーティング・システムのタイプおよびSDKによって異なります。デフォルトのファイル名は次の形式に基づいており、usernameはオペレーティング・システムへのログインに使用したユーザー名です。 username-WebLogicKey.properties また、ファイルを作成した場所が標準出力に出力されます。
nm	オプション。ノード・マネージャのユーザー名およびパスワードを格納するかどうかを指定するブール値。trueに設定した場合は、ノード・マネージャのユーザー名とパスワードが格納されます。この引数のデフォルトはfalseです。

例

次の例では、デフォルトの場所に、ユーザー構成ファイルとキー・ファイルが作成および格納されます。

wls:/mydomain/serverConfig>  storeUserConfig() 
Creating the key file can reduce the security of your system if it is not kept in 
a secured location after it is created. Do you want to create the key file? y or n
y 
The username and password that were used for this current WLS connection are 
stored in C:\Documents and Settings\pat\pat-WebLogicConfig.properties 
and C:\Documents and Settings\pat\pat-WebLogicKey.properties.

次の例では、指定された場所に、ユーザー構成ファイルとキー・ファイルが作成および格納されます。

wls:/mydomain/serverConfig>  storeUserConfig('c:/myFiles/myuserconfigfile.secure', 'c:/myFiles/myuserkeyfile.secure') 
Creating the key file can reduce the security of your system if it is not kept in 
a secured location after it is created. Do you want to create the key file? y or n
y 
The username and password that were used for this current WLS connection are 
stored in c:/myFiles/mysuserconfigfile.secure and c:/myFiles/myuserkeyfile.secure
wls:/mydomain/serverConfig>

threadDump

コマンド・カテゴリ: 情報コマンド

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

説明

指定されたサーバーのスレッド・ダンプを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

threadDump([writeToFile], [fileName], [serverName])

引数	定義
writeToFile	オプション。出力をファイルに保存するかどうかを指定するブール値。この引数のデフォルトはtrueで、出力はファイルに保存されます。
fileName	オプション。出力が書き込まれるファイルの名前。ファイル名は絶対パスでも、WLSTを実行しているディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトはThread_Dump_serverNameファイルです。serverNameはサーバーの名前を表します。この引数は、writeToFileがtrueに設定されている場合にのみ有効です。
serverName	オプション。スレッド・ダンプをリクエストするサーバーの名前。この引数のデフォルトは、WLSTが接続しているサーバーになります。 管理サーバーに接続している場合は、管理サーバーと、WebLogicドメインで動作している任意の管理対象サーバーのスレッド・ダンプを表示できます。管理対象サーバーに接続している場合は、その管理対象サーバーのスレッド・ダンプのみを表示できます。

例

次の例では、現在のサーバーのスレッド・ダンプを表示して、出力をThread_Dump_serverNameファイルに保存します。

wls:/mydomain/serverConfig> threadDump() 

次の例では、サーバーmanagedServerのスレッド・ダンプを表示します。情報はファイルに保存されません。

wls:/mydomain/serverConfig> threadDump(writeToFile='false', serverName='managedServer') 

viewMBean

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

属性名と属性値、操作など、MBeanに関する情報を表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

viewMBean(mbean)

引数	定義
mbean	情報を表示するMBean。

例

次の例では、現在のMBean cmoに関する情報を表示します。

wls:/mydomain/serverConfig> cmo.getType() 
'Domain'
wls:/mydomain/serverConfig> viewMBean(cmo) 
Attribute Names and Values
--------------------------
XMLEntityCaches   null
Targets   javax.management.ObjectName[com.bea
:Name=MedRecJMSServer,Type=JMSServer,
   com.bea:Name=WSStoreForwardInternalJMSServerMedRecServer,Type=JMSServer, 
   com.bea:Name=MedRecWseeJMSServer,Type=JMSServer,
   com.bea:Name=PhysWSEEJMSServer,Type=JMSServer, 
   com.bea:Name=MedRecSAFAgent,Type=SAFAgent, 
   com.bea:Name=AdminServer,Type=Server]
RootDirectory                                .
EmbeddedLDAP                          com.bea:Name=OOTB_medrec,Type=EmbeddedLDAP
RemoteSAFContexts  null
Libraries   javax.management.ObjectName[com.bea
...
wls:/mydomain/serverConfig>

writeIniFile

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

上級ユーザーがJythonモジュールとしてインポートできるように、WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。インポートすると、その定義とメソッド宣言は他のJythonモジュールから使用できるようになり、Jython構文を使用して直接アクセスできます。詳細は、『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項を参照してください。

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

構文

writeIniFile(filePath)

引数	定義
filePath	変換された情報を保存するファイルのフル・パス名。

例

次の例では、WLSTをwl.pyというPythonファイルに変換します。

wls:/offline> writeIniFile("wl.py") 
The Ini file is successfully written to wl.py
wls:/offline> 

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

表3-10に示すWLSTライフサイクル・コマンドを使用して、サーバー・インスタンスのライフサイクルを管理します。

サーバー・インスタンスのライフサイクルの詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』のサーバーのライフサイクルの理解に関する項を参照してください。

表3-10 WLST構成のライフサイクル・コマンド

コマンド	説明	WLSTの使用...
forceShutdownPartitionWait	ドメイン・パーティションを停止し、パーティションが停止するまで待機します。	オンライン
migrate	クラスタ内のターゲット・サーバーにサービスを移行します。	オンライン
migrateResourceGroup	あるターゲットから別のターゲットにドメイン・パーティション・リソース・グループを移行します。	オンライン
resume	一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。	オンライン
scaleDown	指定された動的クラスタの実行している動的サーバーの数を減らします。	オンライン
scaleUp	指定された動的クラスタの実行している動的サーバーの数を増やします。	オンライン
shutdown	実行中のサーバー・インスタンス、クラスタまたはシステム・コンポーネントを正常に停止します。	オンライン
softRestart	システム・コンポーネント・サーバー・インスタンスを再起動します。	オンライン
start	ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。	オンライン
startPartitionWait	ドメイン・パーティションを起動し、パーティションが起動するまで待機します。	オンライン
startServer	管理サーバーを起動します。	オンラインまたはオフライン
suspend	実行中のサーバーを一時停止します。	オンライン

forceShutdownPartitionWait

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

WLSTでの使用: オンライン

説明

既存のパーティションを停止し、パーティションがSHUTDOWN状態になるまで待機します。

パーティションを作成した編集セッションでこのコマンドを使用しないでください。パーティションのライフサイクルの完全な制御には、PartitionLifeCycleRuntimeMBeanコマンドを使用します。

構文

forceShutdownPartitionWait(partition, [timeout])

引数	定義
partition	停止するパーティション。これはDomain.createPartition()またはDomain.lookupPartition()で戻されるようなパーティションのMBeanである必要があります。
timeout	オプション。タイム・アウト(ミリ秒単位)。これはデフォルトで60秒に設定されます。パーティションがタイムアウト内に停止しない場合、コマンドはタイムアウト例外を生成します。

例

次の例では、パーティションpartition1を停止します。

/mydomain/serverConfig> forceShutdownPartitionWait(cmo.lookupPartition("partition1"))

migrate

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

WLSTでの使用: オンライン

説明

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

サービスの移行の詳細は、『Oracle WebLogic Serverクラスタの管理』のサービスの移行に関する項を参照してください。

構文

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

引数	定義
sname	移行する必要のある移行可能ターゲットの名前。
destinationName	サービスの移行先のマシンまたはサーバーの名前。
sourceDown	オプション。元のサーバーを停止するかどうかを指定するブール値。この引数のデフォルトはtrueで、元のサーバーが実行されていないことを示します。 JTAサービスを移行する場合、sourceDown引数が無視され、指定された場合、デフォルトはtrueです。JTAサービスを正常に移行するには、元のサーバーを停止する必要がある。
destinationDown	オプション。移行先のサーバーを停止するかどうかを指定するブール値。この引数のデフォルトはfalseで、移行先のサーバーが実行されていることを示します。 移行先が実行されておらず、この引数をtrueに設定しない場合、WLSTはMigrationExceptionを返します。 JMS関連サービスを実行されていないサーバー・インスタンスに移行する場合、サーバー・インスタンスは次の起動時にJMSサービスをアクティブ化します。JTAトランザクション回復サービスを実行されていないサーバー・インスタンスに移行する場合、ターゲット・サーバー・インスタンスは起動時に回復サービスを前提とします。
migrationType	オプション。移行するサービスのタイプ。有効な値は次のとおりです: jms - JMS関連サービス(JMSサーバー、SAFエージェント、パス・サービス、WebLogic永続ストアなど)のみを移行します。 jta - JTAサービスのみを移行します。 server - サーバー・サービスのみを移行します。 all - すべてのJTAおよびJMSサービスを移行します。 この引数のデフォルトはallです。

例

次の例では、server1にあるすべてのJMSおよびJTAサービスをserver2に移行します。ブール値の引数では、元のサーバーが停止していて、移行先のサーバーが動作していることを指定します。

wls:/mydomain/edit !> migrate('server1','server2', 'true', 'false', 'all') 
Migrating all JMS and JTA services from 'server1' to destination 'server2' ...
wls:/mydomain/edit !>

次の例では、server1にあるすべてのサーバー・サービスをserver2に移行します。ブール値の引数では、元のサーバーが停止していて、移行先のサーバーが動作していることを指定します。

wls:/mydomain/edit !> migrate('server1','server2', 'true', 'false', 'Server') 
Migrating singleton server services from 'server1' to machine 'server2'...
wls:/mydomain/edit !>

migrateResourceGroup

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

WLSTでの使用: オンライン

説明

パーティション・リソース・グループを1つのターゲット(サーバーまたはクラスタ)から別のターゲットへ移行します。パーティション・リソース・グループのターゲットはVirtualTargetsです。VirtualTargetのターゲットはクラスタまたはサーバーです。このコマンドを使用すると、リソース・グループを1つのクラスタ(またはサーバー)から別のクラスタへ移行できます。

1つのクラスタから別のクラスタに移行する場合、この移行中にHTTPセッション状態が保存されます。それ以外の場合、HTTPセッション状態は失われます。

構文

migrateResourceGroup(partitionVirtualTarget, currentTarget, newTarget, [timeout])

引数	定義
partitionVirtualTarget	リソース・グループを現在実行しているVirtualTarget。
currentTarget	partitionVirtualTarget内の物理ターゲット(サーバーまたはクラスタ)。これは移行元の物理ターゲットです。
newTarget	移行先の物理ターゲット(サーバーまたはクラスタ)。これにより、partitionVirtualTargetのcurrentTargetが置き換わります。
timeout	オプション。タイム・アウト(ミリ秒単位)。デフォルトは、無期限に待機する-1です。

例

次の例では、cluster1からcluster2にリソース・グループを移行します。

wls:/mydomain/serverConfig> task = migrateResourceGroup(partition1VT, cluster1, cluster2, 60*1000)

resume

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

WLSTでの使用: オンライン

説明

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。このコマンドはサーバーをRUNNING状態に移行します。サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』のサーバーのライフサイクルの理解に関する項を参照してください。

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

構文

resume([sname], [block])

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

例

次の例では、管理対象サーバー・インスタンスを再開します。

wls:/mydomain/serverConfig> resume('managed1', block='true') 
Server 'managed1' resumed successfully.
wls:/mydomain/serverConfig>

scaleDown

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

WLSTでの使用: オンライン

説明

指定された動的クラスタに対する指定された数の実行している動的サーバーを正常に停止します。サーバーIDが最も大きいサーバーが最初に停止され、続いてその次に大きいIDのサーバーが停止され、指定された数のサーバーが停止されるまで続きます。オプションで、ユーザーは動的クラスタの最大サイズの縮小を指定できます。

構文

scaleDown (clusterName, numServers, [updateConfiguration], [block], [timeoutSeconds], [type])

引数	定義
clusterName	動的クラスタの名前。
numServers	停止するサーバーの数。
updateConfiguration	オプション。WLSTがクラスタの最大サイズを縮小するかどうかを指定するブール値。指定しない場合、この引数はデフォルトでfalseになります。
block	オプション。システム・コンポーネントが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはtrueで、操作が完了するまでユーザーとの対話がブロックされることを示します。falseに設定した場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。
timeoutSeconds	オプション。操作を取り消す前に、WLSTがサーバーの停止を待機する時間(秒単位)。デフォルト値は300秒です。
type	オプション。指定する場合、引数値はDynamicClusterである必要があります。

例

次の例では、動的クラスタmyClusterを2つのサーバー分スケール・ダウンし、操作が完了するまでユーザーの相互作用をブロックします。

wls:/myDomain/serverConfig> scaleDown('myCluster', 2, true, true)
            Remote Scaledown started successfully after 0 seconds.
            Waiting for 2 servers to stop. The timeout is 300 seconds.

            The servers were stopped successfully.
            wls:/myDomain/serverConfig>

scaleUp

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

WLSTでの使用: オンライン

説明

指定された動的クラスタの実行している動的サーバーの数を増やします。サーバーIDが最も小さい実行中でないサーバーが最初に起動され、続いてサーバーIDがその次に大きい実行中でないサーバーが起動されます。オプションで、ユーザーは、クラスタ内に起動対象の実行中でないサーバーが十分にない場合に動的クラスタ構成の最大サイズを増やすことができます。updateConfiguration引数を指定する場合、追加サーバー数の分だけクラスタの最大サイズが拡大され、指定された数のサーバーが起動されます。

構文

scaleUp (clusterName, numServers, [updateConfiguration], [block], [timeoutSeconds], [type])

引数	定義
clusterName	動的クラスタの名前。
numServers	起動するサーバーの数。
updateConfiguration	オプション。実行中でないサーバーが十分にない場合にWLSTがクラスタの最大サイズを増やすかどうかを指定するブール値。指定しない場合、この引数はデフォルトでfalseになります。
block	オプション。システム・コンポーネントが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはtrueで、操作が完了するまでユーザーとの対話がブロックされることを示します。falseに設定した場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。
timeoutSeconds	オプション。操作を取り消す前に、WLSTがサーバーの起動を待機する時間(秒単位)。デフォルト値は600秒です。
type	オプション。指定する場合、引数値はDynamicClusterである必要があります。

例

次の例では、起動する2つの追加サーバーを指定して操作が完了するまでユーザーの相互作用をブロックすることで、動的クラスタmyClusterをスケール・アップします。

wls:/myDomain/serverConfig> scaleUp('myCluster', 2, true, true)
            Remote Scaleup started successfully after 0 seconds.
            Waiting for 2 servers to reach the running state.
            The timeout is 600 seconds.

            1 server(s) transitioned to running. Waiting for 1 more server.

            All servers are now running.
            wls:/myDomain/serverConfig>

shutdown

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

WLSTでの使用: オンライン

説明

実行中のサーバー・インスタンス、クラスタまたはシステム・コンポーネントを正常に停止します。shutdownコマンドは、進行中のすべての作業の完了を待機してから、サーバー、クラスタまたはシステム・コンポーネントを停止します。

引数を指定しないでshutdownコマンドを入力すると、WLSTが接続しているサーバーが停止されます。

管理対象サーバー・インスタンスに接続している場合は、WLSTが接続している管理対象サーバー・インスタンスを停止するためにのみshutdownコマンドを使用できます。管理対象サーバー・インスタンスに接続しているときに、別のサーバーを停止することはできません。

注意: システム・コンポーネント(たとえば、OHSやODIなどのシステム・コンポーネント)を停止するには、WLSTが管理サーバーに接続されている必要があります。

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

構文

shutdown([name], [entityType], [ignoreSessions], [timeOut], [force], [block], [properties], [waitForAllSessions])

引数	定義
name	オプション。停止するサーバー、クラスタまたはシステム・コンポーネントの名前。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。
entityType	オプション。タイプは、Server、ClusterまたはSystemComponentです。指定しない場合は、指定された名前のサーバー、クラスタまたはシステム・コンポーネントが検索されます。
ignoreSessions	オプション。停止時に、WLSTがすべてのHTTPセッションをただちに中止するか、または、HTTPセッションの完了(またはタイムアウト)を待機するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、非永続HTTPセッションが完了(またはタイムアウト)する必要があります。
timeOut	オプション。サーバーを一時停止する前に、サーバーが進行中の作業を完了するのをWLSTが待機する時間(秒単位)。この引数のデフォルトは0秒で、タイムアウトがないことを表します。
force	オプション。WLSTが、アクティブなセッションの完了を待たずに、サーバー・インスタンスまたはクラスタを停止するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのアクティブ・セッションが完了してから停止します。
block	オプション。サーバーが停止されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはtrueで、操作が完了するまでユーザーとの対話がブロックされることを示します。falseに設定した場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。
properties	オプション。entityTypeがSystemComponentの場合にのみ適用されます。システム・コンポーネントに渡すプロパティを指定するプロパティ値。
[waitForAllSessions]	オプション。WLSTが停止中にすべてのHTTPセッションの完了を待機するかどうかを指定するブール値。この引数のデフォルトは、WLSTが非永続HTTPセッションの完了まで待機することを示すfalseになります。

例

次の例では、接続しているサーバーを停止するように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>

softRestart

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

WLSTでの使用: オンライン

説明

実行中のシステム・コンポーネントを再起動します。システム・コンポーネントを再起動するには、WLSTが管理サーバーに接続されている必要があります。

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

構文

softRestart(name, [block], [properties])

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

例

次の例では、ohs1というシステム・コンポーネントを再起動します。

wls:/mydomain/serverConfig> softRestart('ohs1', block='true') 
Restarting the system component with name ohs1 ...
System component with name ohs1 restarted successfully
wls:/mydomain/serverConfig>

start

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

WLSTでの使用: オンライン

説明

ノード・マネージャを使用して、管理対象サーバー・インスタンス、クラスタまたはシステム・コンポーネントを起動します。WLSTが管理サーバーに接続されている必要があります。管理対象サーバーのみの起動の場合は、ノード・マネージャとの接続のみで十分です。

ノード・マネージャに接続して使用するためのWLSTコマンドの詳細は、「ノード・マネージャ・コマンド」を参照してください。

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

構文

start(name, [type], [listenAddress], [port], [block], [properties])

引数	定義
name	起動する管理対象サーバー、クラスタまたはシステム・コンポーネントの名前。
type	オプション。タイプは、Server、ClusterまたはSystemComponentです。指定しない場合は、指定された名前のサーバー、クラスタまたはシステム・コンポーネントが検索されます。
listenAddress	オプション。サーバー・インスタンスのリスニング・アドレス。指定しない場合、このデフォルトはlocalhostになります。タイプにClusterまたはSystemComponentが指定されている場合は無視されます。
port	オプション。サーバー・インスタンスのリスニング・ポート。指定しない場合、このデフォルトは7001になります。タイプにClusterまたはSystemComponentが指定されている場合は無視されます。
block	オプション。サーバーまたはクラスタが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはtrueで、操作が完了するまでユーザーとの対話がブロックされることを示します。falseに設定した場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。
properties	オプション。typeがSystemComponentの場合にのみ適用されます。システム・コンポーネントに渡すプロパティを指定するプロパティ値。

例

次の例では、ノード・マネージャに管理対象サーバー・インスタンスを起動するように指示します。リスン・アドレスはlocalhost、リスン・ポートは8801です。blockがfalseに設定されているので、WLSTはこのコマンドを発行した後で制御をユーザーに返します。

wls:/mydomain/serverConfig> start('myserver', 'Server', block='false') 
Starting server myserver ...
The server start status task for server myserver is assigned to variable
myserverTask
You can call the getStatus(), getError(), getDescription() or isRunning()
methods on this variable to determine the status of your server start
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>

startPartitionWait

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

WLSTでの使用: オンライン

説明

特定のパーティションを起動し、パーティションがリクエストされた状態(デフォルトはRUNNING状態)になるまで待機します。パーティションはすでに存在している必要があります。そのため、パーティションを作成する編集セッションでstartPartitionWaitを使用しないでください。デフォルトでパーティションがSHUTDOWN状態で作成されるため、パーティションで定義されているリソースまたはアプリケーションをアクティブ化するために起動する必要があります。

startPartitionWaitは、便宜のためのコマンドです。パーティションのライフサイクル(パーティションの停止を含む)の完全な制御には、PartitionLifeCycleRuntimeMBeanを使用します。

MBean参照のこのMBeanへのリンクを作成する必要があります。

構文

startPartitionWait(partition, [initialState], [timeout])

引数	定義
partition	起動するパーティション。これはDomain.createPartition()またはDomain.lookupPartition()で戻されるようなPartitionMBeanである必要があります。
initialState	オプション。RUNNINGまたはADMINのいずれかです。指定しない場合、値はデフォルトでRUNNINGに設定されます。
timeout	オプション。WLSTがパーティションの起動を待機する時間(ミリ秒単位)。パーティションがタイムアウト内に起動しない場合、コマンドはタイムアウト例外を生成します。デフォルト値は60000ミリ秒(60秒)です。

例

次の例では、RUNNINGモードのパーティションpartition1を起動します。

wls:/mydomain/serverConfig> startPartitionWait(cmo.lookupPartition("partition1"))

startServer

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

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

説明

管理サーバーを起動します。エラーが発生した場合は、WLSTExceptionが返されます。

注意: MW_HOME/oracle_common/common/binディレクトリからWLSTを実行し、startServerのみを使用してWebLogic管理サーバーを起動できます。startServerを使用して統合型のWebLogic管理サーバー(ORACLE_HOMEディレクトリにインストールされるFusion Middleware Suite製品の管理サーバー)を起動できません。 WebLogic Server以外のFusion Middleware Suite製品の管理サーバーを起動するには、次のいずれかの方法を使用します。 関連するWebLogicドメインのサーバー起動スクリプトを実行します。 ノード・マネージャを使用して、サーバーを起動します。この方法を使用する場合、startScriptEnabledプロパティがノード・マネージャでtrueに設定されていることを確認します。

構文

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

引数	定義
adminServerName	オプション。起動する管理サーバーの名前。この引数のデフォルトはmyserverです。
domainName	オプション。管理サーバーが属しているWebLogicドメインの名前。この引数のデフォルトはmydomainです。
url	オプション。管理サーバーのURL。startServerコマンドに指定したURLによって、config.xmlファイルに指定されたリスン・アドレスとリスン・ポートがオーバーライドされます。この引数がコマンド行またはconfig.xmlファイルに指定されていない場合は、デフォルトのt3://localhost:7001が使用されます。
username	オプション。WLSTをサーバーに接続するときのユーザー名。
password	オプション。WLSTをサーバーに接続するときのパスワード。
domainDir	オプション。管理サーバーが起動されるドメイン・ディレクトリ。この引数のデフォルトは、WLSTの起動元ディレクトリです。
block	オプション。サーバーが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。blockがfalseに設定されると、WLSTはコマンドを発行した後でユーザーに制御を返します。この引数のデフォルトはtrueで、ユーザー対話がブロックされることを示します。『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。
timeout	オプション。操作を取り消す前に、WLSTがサーバーの起動を待機する時間(ミリ秒単位)。デフォルト値は60000ミリ秒です。この引数は、blockがtrueに設定されている場合にのみ適用可能です。
serverLog	オプション。サーバー・ログ・ファイルの場所。この引数のデフォルトはstdoutです。
systemProperties	オプション。サーバー・プロセスに渡すシステム・プロパティ。システム・プロパティは、名前と値のペアをカンマで区切って指定します。名前と値は等号(=)で区切ります。
jvmArgs	オプション。サーバー・プロセスに渡すJVM引数。複数の引数をカンマで区切って指定できます。
spaceAsJvmArgsDelimiter	オプション。JVM引数がスペース区切りであるかどうかを示すブール値。デフォルト値はfalseです。

例

次の例では、demoDomainのdemoServerという管理サーバーを起動します。

wls:/offline> startServer('demoServer','demoDomain','t3://localhost:8001',
'myweblogic','wlstdomain','c:/mydomains/wlst','false', 60000, 
jvmArgs='-XX:MaxPermSize=75m, -Xmx512m, -XX:+UseParallelGC')
wls:/offline>

suspend

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

WLSTでの使用: オンライン

説明

実行中のサーバーを一時停止します。このコマンドでは、サーバーをRUNNING状態からADMIN状態に移行します。サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』のサーバーのライフサイクルの理解に関する項を参照してください。

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

構文

suspend([sname], [ignoreSessions], [timeOut], [force], [block])

引数	定義
sname	オプション。一時停止するサーバーの名前。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。
ignoreSessions	オプション。一時停止するときに、WLSTがすべてのHTTPセッションをただちに中止するか、または、HTTPセッションの完了(またはタイムアウト)を待機するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、HTTPセッションが完了(またはタイムアウト)する必要があります。
timeOut	オプション。サーバーを一時停止する前に、サーバーが進行中の作業を完了するのをWLSTが待機する時間(秒単位)。この引数のデフォルトは0秒で、タイムアウトがないことを表します。
force	オプション。アクティブなセッションの完了を待たずにサーバーを一時停止するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのアクティブ・セッションが完了してからサーバーを一時停止します。
block	オプション。サーバーが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはfalseで、ユーザー対話がブロックされないことを示します。この場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『WebLogic Scripting Toolの理解』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

例

次の例では、管理対象サーバー・インスタンスを一時停止します。

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

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

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

注意: 特に記載のないかぎり、このカテゴリのコマンドを実行するには、ノード・マネージャを実行しておく必要があります。

ノード・マネージャの詳細は、『Oracle WebLogic Serverノード・マネージャの管理』のノード・マネージャの使用に関する項を参照してください。

表3-11 WLST構成のノード・マネージャ・コマンド

コマンド	説明	WLSTの使用...
getNodeManagerHome	ノード・マネージャ・ホームを取得します。	オフライン
getNodeManagerType	ノード・マネージャ・タイプを取得します。	オフライン
getNodeManagerUpgradeOverwriteDefault	ノード・マネージャ・アップグレード上書きデフォルト・フラグの値を取得します。	オフライン
getNodeManagerUpgradeType	ノード・マネージャのアップグレードに使用されるノード・マネージャ・アップグレード・タイプを取得します。	オフライン
getOldNodeManagerHome	ノード・マネージャのアップグレードに使用される古いノード・マネージャ・ホームを取得します。	オフライン
nm	WLSTがノード・マネージャに接続しているかどうかを判断します。	オンライン
nmConnect	WLSTをノード・マネージャに接続してセッションを確立します。	オンラインまたはオフライン
nmDisconnect	WLSTをノード・マネージャ・セッションから接続解除します。	オンラインまたはオフライン
nmEnroll	現在のコンピュータのノード・マネージャを有効にして、指定されたWebLogicドメインのサーバーを管理します。	オンライン
nmExecScript	接続されたノード・マネージャを使用して、名前が付いたスクリプトを実行します。	オンライン
nmGenBootStartupProps	指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。	オンライン
nmKill	ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。	オンラインまたはオフライン
nmLog	ノード・マネージャ・ログを返します。	オンラインまたはオフライン
nmRestart	ノード・マネージャ・インスタンスを再起動します。	オンライン
nmServerLog	ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。	オンラインまたはオフライン
nmServerStatus	ノード・マネージャで起動されたサーバーのステータスを返します。	オンラインまたはオフライン
nmSoftRestart	指定されたシステム・コンポーネント・サーバー・インスタンスを再起動します。	オンラインまたはオフライン
nmStart	ノード・マネージャを使用して、現在のWebLogicドメイン内のサーバーを起動します。	オンラインまたはオフライン
nmVersion	ノード・マネージャのサーバーのバージョンを返します。	オンラインまたはオフライン
startNodeManager	WLSTを実行している同じコンピュータ上のノード・マネージャを起動します。	オンラインまたはオフライン
stopNodeManager	ノード・マネージャを停止します。	オンラインまたはオフライン

getNodeManagerHome

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

WLSTでの使用: オフライン

説明

ドメインのノード・マネージャ・ホーム・ディレクトリを取得します。サポートされない操作の場合は、WLSTExceptionを返します。このコマンドを実行するためにノード・マネージャを実行しておく必要はありません。

構文

getNodeManagerHome()

例

次の例では、ノード・マネージャ・ホーム・ディレクトリを返します。

wls:/offline/base_domain>getNodeManagerHome()
'C:\\domains\\my_domain\\nodemanager'

getNodeManagerType

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

WLSTでの使用: オフライン

説明

ドメインのノード・マネージャ・タイプ(PerDomainNodeManager、CustomLocationNodeManagerまたはManualNodeManagerSetup)を取得します。サポートされない操作の場合は、WLSTExceptionを返します。このコマンドを実行するためにノード・マネージャを実行しておく必要はありません。

ノード・マネージャ・タイプについては、『Oracle WebLogic Serverノード・マネージャの管理』のノード・マネージャのデフォルト構成に関する項を参照してください。

構文

getNodeManagerType()

例

次の例では、ドメインのノード・マネージャ・タイプを返します。この場合は、PerDomainNodeManagerです。

wls:/offline/base_domain>getNodeManagerType()
'PerDomainNodeManager'

getNodeManagerUpgradeOverwriteDefault

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

WLSTでの使用: オフライン

説明

ノード・マネージャ・アップグレード上書きデフォルト・フラグの値を取得します。サポートされない操作の場合は、WLSTExceptionを返します。このコマンドを実行するためにノード・マネージャを実行しておく必要はありません。

構文

getNodeManagerUpgradeOverwriteDefault()

例

次のコマンドは、値trueまたはfalseを返します。

wls:/offline/base_domain>getNodeManagerUpgradeOverwriteDefault()

getNodeManagerUpgradeType

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

WLSTでの使用: オフライン

説明

ドメインの再構成中にノード・マネージャのアップグレードに使用されるノード・マネージャ・アップグレード・タイプを取得します。サポートされない操作の場合は、WLSTExceptionを返します。このコマンドを実行するためにノード・マネージャを実行しておく必要はありません。

構文

getNodeManagerUpgradeType()

例

次の例では、値NewまたはMigrateを返します。

wls:/offline/base_domain>getNodeManagerUpgradeType()

getOldNodeManagerHome

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

WLSTでの使用: オフライン

説明

ドメインの再構成中にノード・マネージャのアップグレードに使用される古いノード・マネージャ・ホームを取得します。サポートされない操作の場合は、WLSTExceptionを返します。このコマンドを実行するためにノード・マネージャを実行しておく必要はありません。

構文

getOldNodeManagerHome

例

この例では、アップグレード中、ドメインの再構成時に使用されたノード・マネージャ・ホーム・ディレクトリ(/scratch/domain/nodemanager)を返します。

wls:/offline/base_domain>getOldNodeManagerHome()
/scratch/domains/nodemanager

nm

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

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

説明

WLSTがノード・マネージャに接続しているかどうかを判断します。trueまたはfalseを返し、説明のメッセージを出力します。このコマンドを実行する前に、ノード・マネージャを実行する必要があります。

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

構文

nm()

例

次の例では、WLSTは現在、mydomainをモニターするノード・マネージャに接続しています。

wls:/mydomain/serverConfig> nm() 
Currently connected to Node Manager that is monitoring the domain "mydomain"
wls:/mydomain/serverConfig>

次の例では、WLSTは現在ノード・マネージャに接続していません。

wls:/mydomain/serverConfig> nm() 
Not connected to any Node Manager
wls:/mydomain/serverConfig>

nmConnect

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

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

説明

WLSTをノード・マネージャに接続してセッションを確立します。ノード・マネージャに接続したら、WLSTからノード・マネージャ・コマンドを呼び出すことができます。このコマンドを実行する前に、ノード・マネージャを実行する必要があります。

注意: 現在のWLSTセッションでconnectコマンドを以前に使用している場合、nmconnectは、特に指定しないかぎり、connectコマンドに使用されたユーザー資格証明を使用します。

接続すると、WLSTプロンプトにはwls:/nm/domainName>と表示されます。domainNameは管理するWebLogicドメインの名前を表します。その後でWLSTをWebLogic Serverに接続すると、プロンプトにはWebLogic Serverインスタンスが示されます。nmコマンドを使用すると、WLSTがノード・マネージャに接続しているかどうかを判断できます(「nm」を参照)。

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

構文

nmConnect(username, password, [host], [port], [domainName], [domainDir] [nmType], [verbose])

nmConnect([userConfigFile, userKeyFile], [host], [port], [domainName], [domainDir], [nmType], [verbose])

引数	定義
username	WLSTをノード・マネージャに接続するオペレータのユーザー名。 注意: 本番モードでサーバーを実行している場合は、ノード・マネージャに接続するときに適切なユーザー名とパスワードが使用されるように、コマンド行でユーザー名とパスワードを明示的に指定する必要があります。
password	WLSTをノード・マネージャに接続するオペレータのパスワード。 注意: 本番モードでサーバーを実行している場合は、ノード・マネージャに接続するときに適切なユーザー名とパスワードが使用されるように、コマンド行でユーザー名とパスワードを明示的に指定する必要があります。
host	オプション。ノード・マネージャのホスト名。この引数のデフォルトはlocalhostです。
port	オプション。ノード・マネージャのポート番号。この引数のデフォルトは、ノード・マネージャ・タイプに基づいた、次の値になります。 plainタイプの場合、デフォルトは5556 rshタイプの場合、デフォルトは514 sshタイプの場合、デフォルトは22 sslタイプの場合、デフォルトは5556
domainName	オプション。管理するWebLogicドメインの名前。この引数のデフォルトはmydomainです。
domainDir	オプション。リモート・ノードのドメインのパスまたはディレクトリこの引数のデフォルトはWLSTを起動したディレクトリです。
nmType	ノード・マネージャ・タイプ。有効な値は次のとおりです: plain - プレーンなソケットのJavaベースの実装 注意: nmTypeにplainを指定する場合、nodemanager.propertiesのSecureListenerパラメータをfalseに手動で設定する必要があります。そうしないと、nmConnectコマンドは失敗します。 rsh - RSH実装 ssh - スクリプト・ベースのSSH実装 ssl - JavaベースのSSL実装 この引数のデフォルトはsslです。
verbose	オプション。WLSTがノード・マネージャに冗長モードで接続するかどうかを指定するブール値。この引数のデフォルトはfalseで、冗長モードは無効になります。
userConfigFile	オプション。暗号化されたユーザー名とパスワードを格納するユーザー構成ファイルの名前と場所。userConfigFile='file-system-path'という構文を使用します。 ユーザー構成ファイルの作成時に、storeUserConfigコマンドはキー・ファイルを使用してユーザー名とパスワードを暗号化します。ユーザー構成ファイルを暗号化するキー・ファイルのみが、そのユーザー名とパスワードを復号化できる(「storeUserConfig」を参照。)
userKeyFile	オプション。指定されたユーザー構成ファイルに関連付けられていて、そのファイルの復号化に使用されるキー・ファイルの名前と場所。userKeyFile='file-system-path'という構文を使用します。(「storeUserConfig」を参照。)

例

次の例では、デフォルトのホストおよびポート番号とplainノード・マネージャ・タイプを使用して、oamdomainをモニターするノード・マネージャにWLSTを接続します。

wls:/myserver/serverConfig> nmConnect('username', 'password, 'localhost',
'5555', 'oamdomain', 'c:/Oracle/Middleware/user_projects/domains/oamdomain','ssl') 
Connecting to Node Manager Server ... 
Successfully connected to Node Manager.
wls:/nm/oamdomain>

次の例では、ユーザー資格証明を提供するユーザー構成ファイルとキー・ファイルを使用して、WLSTをノード・マネージャ・サーバー・インスタンスに接続します。

wls:/myserver/serverConfig> nmConnect(userConfigFile='
c:/myfiles/myuserconfigfile.secure', 
userKeyFile='c:/myfiles/myuserkeyfile.secure', 
host='172.18.137.82', port=26106, domainName='mydomain', 
domainDir='c:/myfiles/mydomain', nmType='ssl') 
Connecting to Node Manager Server ...
Successfully connected to Node Manager.
wls:/nm/mydomain>

nmDisconnect

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

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

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

説明

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

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

構文

nmDisconnect()

例

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

wls:/nm/oamdomain> nmDisconnect() 
Successfully disconnected from Node Manager
wls:/myserver/serverConfig>

nmEnroll

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

WLSTでの使用: オンライン

説明

WLSTが現在動作しているマシンを登録します。このコマンドを実行するにはWLSTが管理サーバーに接続している必要がありますが、ノード・マネージャに接続している必要はありません。

このコマンドでは、次のファイルを管理サーバーからダウンロードします。

• ノード・マネージャ秘密ファイル(nm_password.properties)。サーバー認証に使用される暗号化されたユーザー名とパスワードが含まれます。

• SerializedSystemIni.datファイル。

また、このコマンドは、NodeManagerHomeディレクトリにあるnodemanager.domainsファイルをドメイン情報で更新します。Javaベースのノード・マネージャの場合、このファイルは通常domain_home\nodemanagerにあります。スクリプト・ベースのノード・マネージャでは、このファイルのデフォルトの場所はWL_HOME/common/nodemanagerになります。WL_HOMEはWebLogic Serverのインストール先ディレクトリ(ORACLE_HOME/wlserverなど)です。

WebLogicドメインが管理サーバーとルート・ディレクトリを共有している場合を除いて、このコマンドは1つのWebLogicドメイン、1つのマシンごとに実行する必要があります。

このコマンドを実行するときにそのマシンがすでに登録されている場合は、ノード・マネージャ秘密ファイル(nm_password.properties)が管理サーバーの最新の情報で更新されます。

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

構文

nmEnroll([domainDir], [nmHome])

引数	定義
domainDir	オプション。リモート・ノードのドメインのパスまたはディレクトリこの引数のデフォルトはWLSTを起動したディレクトリです。
nmHome	オプション。ノード・マネージャ・ホームのパス。ドメイン情報を含むnodemanager.domainsファイルはこのディレクトリに書き込まれます。この引数のデフォルトはWL_HOME/common/nodemanagerです。WL_HOMEはWebLogic Serverの最上位のインストール・ディレクトリです。

例

次の例では、現在のマシンをノード・マネージャに登録して、ノード・マネージャ秘密ファイル(nm_password properties)とSerializedSystemIni.datファイルをc:/Oracle/Middleware/mydomain/common/nodemanager/nm_password.propertiesに保存します。nodemanager.domainsファイルはデフォルトではWL_HOME/common/nodemanagerに書き込まれます。

wls:/mydomain/serverConfig> nmEnroll('c:/Oracle/Middleware/mydomain/common/nodemanager') 
Enrolling this machine with the domain directory at c:\Oracle\Middleware\mydomain\common\nodemanager....
Successfully enrolled this machine with the domain directory at C:\Oracle\Middleware\mydomain\common\nodemanager
wls:/mydomain/serverConfig>

nmExecScript

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

WLSTでの使用: オンライン

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

説明

接続されたノード・マネージャを使用して、名前が付いたスクリプトを実行します。

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

構文

nmExecScript(scriptName, [scriptDir], [scriptProps], [writer], [timeout])

引数	定義
scriptName	実行するスクリプトの名前。これは、パス情報なしのスクリプトの名前である必要があり、ディスク上のファイルの名前と一致する必要があります。
scriptDir	オプション。ノード・マネージャがスクリプトを検出できるドメイン・ディレクトリの下にあるディレクトリ。これは、既知のスクリプトの場所のいずれかである必要があります。デフォルトでは、NodeManagerはmydomain/bin/service_migrationディレクトリ(mydomainはドメイン固有のディレクトリ)をチェックします。
scriptProps	オプション。環境変数としてスクリプトに指定されるプロパティ。この引数のデフォルトはNoneです。
writer	オプション。スクリプト出力が書き込まれるjava.io.Writerオブジェクト。この引数のデフォルトはWLSTライターです。
timeout	オプション。スクリプトの実行の完了を待機するミリ秒数。指定ミリ秒数待機した後、ノード・マネージャはスクリプト・プロセスの取消しを試行し、使用できる出力を収集し、クリーンアップします。ノード・マネージャは、エラーとしてタイムアウトを戻します。デフォルトでは、ノード・マネージャは、スクリプトの実行の完了を待機します。

例

次の例では、接続されたノード・マネージャを使用してfoo.shという名前のスクリプトを実行し、スクリプトの実行の完了に20000ミリ秒待機します。

wls:/nm/oamdomain> nmExecScript('foo.sh', timeout=20000)
output from script
wls:/myserver/serverConfig>

nmGenBootStartupProps

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

WLSTでの使用: オンライン

説明

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。ノード・マネージャ・プロパティ・ファイルは、指定されたサーバーのルート・ディレクトリを基準とする相対的な場所に格納されます。対象となるルート・ディレクトリは、コマンドを実行しているマシンと同じマシン上にある必要があります。

サーバーの名前を指定する必要があります。そうしないと、コマンドは失敗します。

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

構文

nmGenBootStartupProps(serverName)

引数	定義
serverName	ノード・マネージャ・プロパティ・ファイルを生成するサーバーの名前。

例

次の例では、指定されたサーバーms1のルート・ディレクトリ内にboot.propertiesおよびstartup.propertiesを生成します。

wls:/mydomain/serverConfig> nmGenBootStartupProps('ms1') 
Successfully generated boot.properties at 
c:\Oracle\Middleware\mydomain\servers\ms1\data\nodemanager\boot.properties
Successfully generated startup.properties at 
c:\Oracle\Middleware\mydomain\servers\ms1\data\nodemanager\startup.properties
wls:/mydomain/serverConfig>

nmKill

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

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

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

説明

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

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

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

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

構文

nmKill([serverName], [serverType], [pluginProps])

引数	定義
serverName	オプション。強制停止するサーバーの名前。この引数のデフォルトはmyserverです。
serverType	オプション。強制停止するサーバーのタイプ。この引数のデフォルトはWebLogicです。もう1つの有効なオプションはCoherenceです。
pluginProps	オプション。サーバーを強制停止するために使用するプロパティ。デフォルトはNoneです。プラグインを処理するシステム・コンポーネントのみに関係します。

例

次の例では、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>

nmRestart

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

WLSTでの使用: オンライン

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

説明

接続されたノード・マネージャ・インスタンスを再起動します。

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

構文

nmRestart([timeout])

引数	定義
timeout	オプション。再起動後にクライアントのNodeManagerへの再接続をWLSTが待機するミリ秒数。指定されたミリ秒数が経過すると、コマンドはタイムアウトを示すエラーを戻します。デフォルトでは、コマンドは再起動されたノード・マネージャへの接続をクライアントが正常に完了するまでブロックします。

例

次の例では、タイムアウトを指定し、ノード・マネージャ・インスタンスを再起動します。

wls:/nm/oamdomain> nmRestart(5000)
Restarted Node Manager Process successfully
wls:/myserver/serverConfig>

nmServerLog

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

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

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

説明

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

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

構文

nmServerLog([serverName], [writer], [serverType])

引数	定義
serverName	オプション。サーバーの出力ログを表示するサーバーの名前。この引数のデフォルトはmyserverです。
writer	オプション。ログ出力を書き込むjava.io.Writerオブジェクト。指定しない場合、この引数のデフォルトはWLSTInterpreter標準出力になります。
serverType	オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。もう1つの有効なオプションはCoherenceです。

例

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

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

nmServerStatus

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

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

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

説明

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

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

構文

nmServerStatus([serverName], [serverType])

引数	定義
serverName	オプション。ステータスを表示するサーバーの名前。この引数のデフォルトはmyserverです。
serverType	オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。もう1つの有効なオプションはCoherenceです。

例

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

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

nmSoftRestart

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

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

説明

ノード・マネージャで起動された指定のシステム・コンポーネント・サーバー・インスタンスを再起動します。このコマンドは、現在ノード・マネージャとWLSTでサポートされているOracleシステム・コンポーネント(OHSなど)にのみ使用できます。

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

起動する際にノード・マネージャを使用しなかったシステム・コンポーネント・サーバー・インスタンスを再起動しようとすると、エラーが表示されます。WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

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

構文

nmSoftRestart([serverName], serverType, [pluginProps])

引数	定義
serverName	オプション。再起動するシステム・コンポーネント・サーバーの名前。デフォルトはmyServerです。
serverType	必須。起動するサーバーのタイプ(OHSなど)。この引数に使用する適切な値を決定するには、該当システム・コンポーネントの管理ガイドなどのドキュメントを参照してください。
pluginProps	オプション。サーバーを強制停止するために使用するプロパティ。デフォルトはNoneです。プラグインを処理するシステム・コンポーネントのみに関係します。

例

次の例では、ohsServerというシステム・コンポーネント・サーバー・インスタンスを起動します。

wls:/nm/oamdomain> nmSoftRestart('ohsServer', 'OHS')
Restarting server 'ohsServer' ...
Server ohsServer restarted successfully.
wls:/nm/oamdomain>

nmStart

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

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

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

説明

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

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

注意: nmStartを使用してサーバーを起動するには、boot.propertiesが必要です。今回初めてサーバーを起動するか、初めてノード・マネージャを使用する場合は、これを手動で作成するか、nmGenBootStartupPropsコマンドを実行してそのサーバー用のboot.propertiesファイルおよびstartup.propertiesファイルを作成する必要があります。 または、nmStartprops引数を使用して、ユーザー資格証明を提供できます(ノード・マネージャの接続後)。 prps = makePropertiesObject("AdminURL=http://listen_address:listen_port;Username=username;Password=password") nmStart("AdminServer",props=prps)

構文

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

引数	定義
serverName	オプション。起動するサーバーの名前。
domainDir	オプション。起動するサーバーのドメイン・ディレクトリ。この引数のデフォルトは、WLSTの起動元ディレクトリです。
props	オプション。新しいサーバーに適用するシステム・プロパティ。
writer	オプション。サーバー出力が書き込まれるjava.io.Writerオブジェクト。この引数のデフォルトはWLSTライターです。
serverType	オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。もう1つの有効なオプションはCoherenceです。
pluginProps	オプション。サーバーの起動に使用するプロパティ。デフォルトはNoneです。プラグインを処理するシステム・コンポーネントのみに関係します。

例

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

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

次の例では、ノード・マネージャを使用して、指定されたWebLogicドメインで管理サーバーを起動します。この例では、prps変数にシステム・プロパティ設定を格納し、props引数を使用してコマンドに渡されます。

wls:/nm/mydomain> prps = makePropertiesObject("AdminURL=http://
listen_address;listen_port;Username=username;Password=password
;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を実行している同じコンピュータ上のノード・マネージャを起動します。

注意: 本番環境では、ノード・マネージャの起動にstartNodeManagerコマンドを使用しないことをお薦めします。推奨方法は、サービスまたはデーモンとしてノード・マネージャをインストールするか、startNodeManagerスクリプト(startNodeManager.shまたはstartNodeManger.cmd)を使用します。

startNodeManagerコマンドを呼び出すときに、ノード・マネージャをすでに実行している場合は、次のメッセージが表示されます。

A Node Manager has already been started.
Cannot start another Node Manager process via WLST

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

構文

startNodeManager([verbose], [block], [timeout], [jvmArgs], [nmProperties], [nmConnectionOptions])

引数	定義
verbose	オプション。WLSTがノード・マネージャを冗長モードで起動するかどうかを指定するブール値。この引数のデフォルトはfalseで、冗長モードは無効になります。
block	オプション。NodeManagerに正常に接続するまでまたはtimeout引数で指定された時間内にNodeManagerに接続できなかった場合にWLSTがブロックするかどうかを指定するブール値。 このオプションのデフォルトはfalseです。このオプションをtrueに設定する場合、nmConnectに使用するユーザー名、パスワード、ホスト、ポート、ドメイン名およびノード・マネージャ・タイプを指定する必要があります。
timeout	オプション。WLSTによるNodeManagerへの接続を待機するミリ秒数。このオプションのデフォルトは、120000ミリ秒です。
jvmArgs	オプション。サーバー・プロセスに渡すJVM引数。複数の引数をカンマで区切って指定できます。 この引数の使用方法は、例を参照してください。
nmProperties	オプション。ノード・マネージャ・プロパティのカンマ区切りのリスト。名前と値のペアで指定します。ノード・マネージャ・プロパティの例としては、NodeManagerHome、ListenAddress、ListenPort、PropertiesFileなどがあげられます。
nmConnectionOptions	blockがfalseである場合はオプションで、blockがtrueである場合は必須です。nmConnectオプションのカンマ区切りのリスト。次の引数は必須です。 username、password、host、portおよびdomainName 次の引数はオプションです。 domainDirおよびnmType。

例

次の例では、C:/Oracle/Middleware/wlserver/common/nodemanagerをノード・マネージャ・ホームとし、ポート6666をmyhost上のノード・マネージャ・リスニング・アドレスとして、ノード・マネージャを起動します。JVM引数は、ノード・マネージャのJVMの初期メモリーおよび最大メモリーを設定します。

wls:/mydomain/serverConfig> startNodeManager(block='true', timeout=30000,verbose='true', NodeManagerHome='c:/Oracle/Middleware/wlserver/common/nodemanager', ListenPort='6666', ListenAddress='myhost', jvmArgs='-Xms24m,-Xmx64m')
Launching Node Manager ...
Successfully launched the Node Manager.
The Node Manager process is running independent of the WLST process
Exiting WLST will not stop the Node Manager process. Please refer
to the Node Manager logs for more information.
The Node Manager logs will be under c:\Oracle\Middleware\wlserver\common\nodemanager.
wls:/mydomain/serverConfig>

stopNodeManager

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

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

説明

ノード・マネージャ・プロセスを停止します。

注意: ノード・マネージャ・プロセスを停止するには、startNodeManagerを使用してノード・マネージャを起動するか、ノード・マネージャをプロパティQuitEnabled=trueを使用して起動する必要があります。$WLS_HOME/common/nodemanager.propertiesでこのプロパティを構成できます。これにより、ノード・マネージャに接続して停止できます。

stopNodeManagerコマンドを呼び出すときに、ノード・マネージャを実行していない場合は、次のメッセージが表示されます。

Cannot stop the Node Manager unless you are connected to it.

構文

stopNodeManager()

例

次の例では、base_domainドメインのノード・マネージャ・プロセスを停止します。

wls:/nm/base_domain> stopNodeManager()
Stopped Node Manager Process successfully
wls:/offline>

ツリー・コマンド

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

表3-12 WLST構成のツリー・コマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
custom	サーバーに登録されているカスタムMBeanのルートに移動します。	オンライン
domainConfig	ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。	オンライン
domainCustom	ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します	オンライン
domainRuntime	ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。	オンライン
edit	編集構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。	オンライン
editCustom	カスタムMBeanのルートに移動します。	オンライン
jndi	WLSTが現在接続しているサーバーのJNDIツリーに移動します。	オンライン
serverConfig	構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。	オンライン
serverRuntime	実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。	オンライン

custom

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

WLSTでの使用: オンライン

説明

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

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

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

カスタムMBeanの詳細は、『Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』を参照してください。

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

注意: domainCustom()コマンドを使用して、ドメイン実行時MBeanサーバー上のカスタムMBeanに移動することもできます。詳細は、「domainCustom」を参照してください。

構文

custom([objectNamePattern])

引数	定義
ObjectNamePattern	sip:*などのJMX問合せパターン。デフォルト値は、nullまたは*:*です。

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層からカスタムMBean階層に移動します。

wls:/mydomain/serverConfig> custom() 
Location changed to custom tree. This is a writeable tree with No root. For more help, use help('custom')
wls:/mydomain/custom> 

domainConfig

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

WLSTでの使用: オンライン

説明

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。この読込み専用の階層には、現在のWebLogicドメインを表す構成MBeanが格納されています。

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

構文

domainConfig()

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層からWebLogicドメインの構成階層に移動します。

wls:/mydomain/serverConfig> domainConfig() 
Location changed to domainConfig tree. This is a read-only tree with DomainMBean as the root.
For more help, use help('domainConfig')
wls:/mydomain/domainConfig> ls() 
dr--   AppDeployments
dr--   BridgeDestinations
dr--   Clusters
dr--   CustomResources
dr--   DeploymentConfiguration
dr--   Deployments
dr--   EmbeddedLDAP
dr--   ErrorHandlings
dr--   FileStores
dr--   InternalAppDeployments
dr--   InternalLibraries
dr--   JDBCDataSourceFactories
dr--   JDBCStores
dr--   JDBCSystemResources
dr--   JMSBridgeDestinations
dr--   JMSInteropModules
dr--   JMSServers
dr--   JMSSystemResources
...
wls:/mydomain/domainConfig>

domainCustom

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

WLSTでの使用: オンライン

説明

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

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

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

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

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

構文

domainCustom(ObjectNamePattern)

引数	定義
ObjectNamePattern	sip:*などのJMX問合せパターン。デフォルト値は、nullまたは*:*です。

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層からドメイン・カスタムMBean階層に移動します。

wls:/mydomain/serverConfig> domainCustom()
Location changed to domain custom tree. This is a writeable tree with No root. For more help, use help('domainCustom').

wls:/mydomain/domainCustom

domainRuntime

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

WLSTでの使用: オンライン

説明

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。この読込み専用の階層には、現在のWebLogicドメインを表す実行時MBeanが格納されています。

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

構文

domainRuntime()

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層からドメインの実行時階層に移動します。

wls:/mydomain/serverConfig> domainRuntime() 
wls:/mydomain/domainRuntime> ls() 
dr--   AppRuntimeStateRuntime
dr--   DeployerRuntime
dr--   DomainServices
dr--   LogRuntime
dr--   MessageDrivenControlEJBRuntime
dr--   MigratableServiceCoordinatorRuntime
dr--   MigrationDataRuntimes
dr--   SNMPAgentRuntime
dr--   ServerLifeCycleRuntimes
dr--   ServerRuntimes
dr--   ServerServices

-r--   ActivationTime                               Mon Aug 01 11:41:25 EDT 2005
-r--   Clusters                                     null
-r--   MigrationDataRuntimes                        null
-r--   Name                                         sampleMedRecDomain
-rw-   Parent                                       null
-r--   SNMPAgentRuntime                             null
-r--   Type                                         DomainRuntime
-r-x   restartSystemResource                        Void :
       WebLogicMBean(weblogic.management.configuration.SystemResourceMBean)
wls:/mydomain/domainRuntime>

edit

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

WLSTでの使用: オンライン

説明

編集構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。この書込み可能な階層には、現在のWebLogicドメインを表すすべての構成MBeanが格納されています。

注意: 構成Beanを編集するには、管理サーバーに接続する必要があります。管理対象サーバーに接続した場合、WLSTの機能は構成Bean階層の参照だけに制限されます。WLSTを使用して管理対象サーバー上のMBeanの値を変更することはできませんが、管理APIを使用すれば可能です。ただし、管理サーバー上の構成MBeanの値のみを変更することをお薦めします。管理対象サーバー上のMBeanの値を変更すると、ドメイン構成に矛盾が生じる可能性があります。 構成Beanの編集の詳細は、『WebLogic Scripting Toolの理解』のWLSTオンラインを使用した既存ドメインの更新に関する項を参照してください。

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

構文

edit([editSessionName])

引数	定義
editSessionName	オプション。コンテキストに移動する編集セッションの名前。指定された名前の編集セッションが存在しない場合、自動的に作成されます。この引数が指定されない場合、デフォルトの編集セッションが使用されます。

例

次の例では、管理サーバー・インスタンス上で、サーバー構成MBean階層から、ドメイン構成MBean階層の編集可能なコピーに移動する方法を示しています。指定された編集セッションの名前mySampleを呼び出します。この編集セッションは存在しないため、指定された名前で自動的に作成されます。

wls:/myserver/serverConfig> edit() 
Location changed to edit tree. This is a writeable tree with DomainMBean as the root.
To make changes you will need to start an edit session via startEdit().
For more help, use help('edit')
wls:/wls/edit> edit('mySample')
Edit session mySample does not exist. Creating.
 
wls:/wls/edit(mySample)>

editCustom

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

WLSTでの使用: オンライン

説明

編集MBeanServerに登録されているカスタムMBeanのルートに移動します。WLSTは、カスタムMBeanへの移動、照会、編集を行いますが、editCustomコマンドを使用してアクセスされるMBeanは、スタブを利用できないため、cmo変数を使用できません。

editCustomコマンドは、WLSTが管理サーバー・インスタンスに接続されている場合に使用できます。

カスタムMBeanの詳細は、『WebLogic Scripting Toolの理解』の他のWebLogic MBeanおよびカスタムMBeanへのアクセスに関する項を参照してください。

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

構文

editCustom([ObjectNamePattern)

引数	定義
ObjectNamePattern	オプション。sip:*などのJMX問合せパターン。デフォルト値は、*:*またはnullです。

例

次の例では、場所をeditCustomツリーに変更します。これは、ルートのない書込み可能なツリーです。

wls:/mydomain/serverConfig> editCustom()
wls:/mydomain/editCustom>

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が返されます。

詳細は、『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> 

ストア管理コマンド

表3-13に一覧表示されているストア管理コマンドを使用して、JDBCストアおよびファイル・ストアを管理します。これらのコマンドの詳細は、『Oracle WebLogic Serverサーバー環境の管理』のWLSTを使用したストア管理に関する項を参照してください。

表3-13 ストア管理コマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
closestore	ストアを閉じます。	オフライン
compactstore	ファイル・ストアによって占有されているスペースを圧縮およびデフラグします。	オフライン
dumpstore	ストア・コンテンツを判読可能な形式でXMLファイルへダンプします。	オフライン
getopenstores	開かれているストアのリストを戻します(スクリプト・アクセス用)。	オフライン
getstoreconns	指定したストア内の接続のリストを戻します(スクリプト・アクセス用)。	オフライン
liststore	ストア名、開かれているストア、またはストア内の接続を一覧表示します。	オフライン
openfilestore	ファイル・ストアを開きます。	オフライン
openjdbcstore	JDBCストアを開きます。	オフライン

closestore

コマンド・カテゴリ: ストア管理

WLSTでの使用: オフライン

説明

前に開かれたファイル・ストアまたはJDBCストアを閉じます。このコマンドは、正常に完了すると1を、エラーが発生すると0を返します。

構文

closestore(store)

引数	定義
store	前に開かれたJDBCまたはファイル・ストアの名前。

例

次の例では、myJDBCStoreという名前のJDBCストアを閉じています。

wls:/offline> closestore('myJDBCStore')

compactstore

コマンド・カテゴリ: ストア管理

WLSTでの使用: オフライン

説明

ファイル・ストアによって占有されているスペースを圧縮およびデフラグします。このコマンドはWLSTオフラインでのみ機能し、JDBCストアには使用できません。このコマンドは、正常に完了すると1を、エラーが発生すると0を返します。

注意: ファイル・ストアの実行は、スペースに関係なく速度に最適化されます。したがって、圧縮を実行すればストア・サイズを縮小でき、割り当てられたスペースをより効率的に利用できます。

構文

compactstore(dir, [tempdir])

引数	定義
dir	ファイル・ストアが格納されるディレクトリ。
tempdir	オプション。圧縮中に使用される一時ディレクトリ。このディレクトリは指定したファイル・ストア・ディレクトリの下に配置せず、ファイル・ストアに対して十分なスペースを確保してください

例

次の例は、ファイル・ストア・ファイルに占有されていたスペースをmystoresディレクトリに圧縮します。

wls:/offline> compactstore('/mystores', '/tmpmystore.dir')

dumpstore

コマンド・カテゴリ: ストア管理

WLSTでの使用: オフライン

説明

ストアまたは接続の内容を、人間が読み取れる形式で、指定したXMLファイルにダンプします。XMLファイルの形式は、永続ストアの診断イメージで使用する形式と同じです。このコマンドは、正常に完了すると1を、エラーが発生すると0を返します。

構文

dumpstore(store, outfile, [conn], [deep])

引数	定義
store	前に開かれたJDBCまたはファイル・ストアの名前。
outfile	情報をダンプする先のXMLファイル名(.xml拡張子あり、またはなしで)。
conn	オプション。ダンプをそこに限定するストア接続名。
deep	オプション。trueの場合は、ストア・レコード・データの内容が、16進ダンプでダンプ出力に追加されます。この引数のデフォルトはfalseです。

例

次の例では、myJDBCStoreの内容がmystoredump-out.xmlファイルにダンプされます。

wls:/offline> dumpstore('myJDBCStore', 'mystoredump-out')

getopenstores

コマンド・カテゴリ: ストア管理

WLSTでの使用: オフライン

説明

開かれているストアのリストを戻します(スクリプト・アクセス用)。このコマンドは、正常に完了すると1を、エラーが発生すると0を返します。

構文

getopenstores()

例

次の例は、開かれているストアのリストを戻します。

wls:/offline> getopenstores()
array(java.lang.String,[])

getstoreconns

コマンド・カテゴリ: ストア管理

WLSTでの使用: オフライン

説明

指定したストア内の接続のリストを戻します(スクリプト・アクセス用)。このコマンドは、正常に完了すると1を、エラーが発生すると0を返します。

構文

getstoreconns(store)

引数	定義
store	前に開かれたJDBCまたはファイル・ストアの名前。

例

次の例は、JDBCストアmyJDBCStoreの接続のリストを戻します。

wls:/offline> getstoreconns('myJDBCStore')
array(java.lang.String,[])

liststore

コマンド・カテゴリ: ストア管理

WLSTでの使用: オフライン

説明

ストア名、開かれているストアまたは(インタラクティブ・アクセスの)接続のリストを示します。このコマンドは、正常に完了すると1を、エラーが発生すると0を返します。

構文

liststore([store], [dir])

引数	定義
store	オプション。前に開かれたJDBCまたはファイル・ストアの名前。
dir	オプション。利用可能なストア名のリストを示すディレクトリ。

例

次の例は、myJDBCStoreという名前のJDBCストアの接続のリストを示します。

wls:/offline> liststore('myJDBCStore')

openfilestore

コマンド・カテゴリ: ストア管理

WLSTでの使用: オフライン

説明

それ以降の処理のために既存のファイル・ストアを開きます。ファイル・ストアが存在しない場合は、-createパラメータに基づいて、開かれた状態の新しいファイル・ストアが作成されます。このコマンドは、正常に完了すると1を、エラーが発生すると0を返します。

構文

openfilestore(store, [dir], [create])

引数	定義
store	開くストア名。
dir	オプション。ストア・ファイルが格納されているファイル・システム・ディレクトリ名。この引数のデフォルトは「.」です。
create	オプション。trueに設定すると、存在していないファイル・ストアが作成されます。デフォルト値はfalseです。

例

次の例では、myJDBCStoreという名前のファイル・ストアが作成されます。

wls:/offline> openfilestore('myJDBCStore', '', 'true')

openjdbcstore

コマンド・カテゴリ: ストア管理

WLSTでの使用: オフライン

説明

それ以降の処理のために既存のJDBCストアを開きます。JDBCストアが存在しない場合は、開かれた状態の新しいJDBCストアが作成されます。このコマンドは、正常に完了すると1を、エラーが発生すると0を返します。

構文

openjdbcstore(store, [driver], [url], [propfile], [user], [password], [ddl], tableNamePrefix])

引数	定義
store	開くストアの名前。
driver	オプション。JDBCドライバ・クラス名。この引数のデフォルトは、nullです。
url	オプション。データベースに接続するURL。
propfile	オプション。JDBCプロパティ・ファイル。この引数のデフォルトは、nullです。
user	オプション。データベースにアクセスするためのユーザー名。この引数のデフォルトは、nullです。
password	オプション。データベースにアクセスするためのパスワード。この引数のデフォルトは、nullです。
ddl	オプション。データベースの表形式を定義するDDLファイル名。この引数のデフォルトは、nullです。
tableNamePrefix	オプション。データベース表を命名する接頭辞。この引数のデフォルトは、nullです。

例

次の例では、myJDBCStoreというJDBCストアを開いています。DDLファイルは指定されていません。

wls:/offline> openjdbcstore('myJDBCStore', 'oracle.jdbc.OracleDriver',
'jdbc:oracle:thin:@test231:1521:test123', './wlstoreadmin-dump.props',
'dbuser', 'dbpw', '', 'jdbcstoreprefix')

WLST変数リファレンス

表3-14では、WLSTの変数とその一般的な使用方法について説明します。すべての変数はユーザー・セッションの開始時にデフォルト値に初期化されて、ユーザーとWLSTの対話に従って変更されます。

表3-14 WLST変数

変数	説明	例
cmgr	cmgr変数には、ConfigurationManagerMBeanが設定されます。この変数を使用すると、ConfigurationManagerMBean属性の現在の値を取得できます。	wls:/mydomain/edit> cmgr.getCurrentEditor() 'weblogic'
cmo	現在の管理オブジェクト。cmo変数には、WLSTを使用して移動したBeanインスタンスが設定されます。この変数を使用すると、現在のBeanインスタンスのget、set、またはinvokeメソッドを実行できます。 WLSTでは、この変数が現在のWLSTパスに設定されます。たとえば、serverConfig階層に変更すると、cmoはDomainMBeanに設定されます。serverRuntime階層に変更すると、cmoはServerRuntimeMBeanに設定されます。 この変数は、カスタムおよびjndi以外のすべてのWLST階層で利用できます。	wls:/mydomain/edit> cmo.setAdministrationPort(9092)
connected	WLSTが実行中のサーバーに接続しているかどうかを示すブール値。WLSTは、実行中のサーバーに接続する場合、この変数をtrueに設定します。それ以外の場合はfalseに設定します。	wls:/mydomain/serverConfig> print connected false
domainName	WLSTが接続しているWebLogicドメインの名前。	wls:/mydomain/serverConfig> print domainName mydomain
domainRuntimeService	DomainRuntimeServiceMBean MBean。この変数は、WLSTが管理サーバーに接続している場合にのみ使用できます。	wls:/mydomain/serverConfig> domainRuntimeService.getServerName() 'myserver'
editService	EditServiceMBean MBean。この変数は、WLSTが管理サーバーに接続している場合にのみ使用できます。	wls:/mydomain/edit> dc = editService.getDomainConfiguration()
exitonerror	例外が発生した場合にWLSTがスクリプトの実行を終了するかどうかを指定するブール値。この変数のデフォルトはtrueで、WLSTでエラーが発生するとスクリプトの実行は終了します。この変数は、WLSTを対話モードで実行する場合には適用できません。	wls:/mydomain/serverConfig> print exitonerror true
home	ローカルMBeanHomeを表します。	wls:/mydomain/serverConfig> print home weblogic.rmi.internal.BasicRemoteRef - hostID: '-hostID:[7001,7001,-1,-1,-1,-1,-1]:mydomain:AdminServer', oid: '260', channel: 'null'
idd	WLSTに現在接続しているユーザーのアイデンティティ・ドメイン。	wls:/mydomain/serverConfig> print idd dbUsers
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