2 WLSTコマンドおよび変数リファレンス
WebLogic Serverには、WebLogic Serverインスタンスへの接続、構成Beanまたは実行時Beanの階層の移動、アプリケーションのデプロイ、サーバーのライフサイクルの制御、診断データの管理、JDBCストアの管理など、特定の管理および監視タスクを対象としているWLSTコマンドが含まれます。
この章の内容は次のとおりです。
WLSTコマンド・カテゴリの概要
Oracle WebLogic Serverを管理および監視するために使用できるWLSTコマンドのカテゴリについて学習します。
ノート:
コマンド構文要件は、WebLogic Scripting Toolの理解のWLSTコマンドの構文を参照してください。
WLSTコマンドは次のカテゴリに分かれています。
ノート:
WebLogic Server Multitenantドメイン・パーティション、リソース・グループ、リソース・グループ・テンプレートおよび仮想ターゲットは、WebLogic Server 12.2.1.4.0で非推奨になり、次のリリースで削除されます。
表2-1 WLSTコマンド・カテゴリ
コマンド・カテゴリ | 説明 |
---|---|
構成Beanまたは実行時Beanの階層を移動します。プロンプトの表示を制御します。 |
|
|
|
WLST |
|
|
|
診断データをエクスポートします。 |
|
構成Beanの照会や編集を行います。 |
|
WebLogicドメイン、サーバー、変数に照会します。構成Bean、実行時Bean、WLSTに関連した情報を提供します。 |
|
サーバー・インスタンスまたはシステム・コンポーネント・インスタンスのライフ・サイクルを管理します。 |
|
ノード・マネージャを使用して、WebLogic Serverインスタンスおよびシステム・コンポーネント・インスタンスを起動、停止、再起動およびモニターします。 |
|
MBean階層内を移動します。 |
|
JDBCストアおよびファイル・ストアを管理します。 |
参照コマンド
表2-2 WLST構成の参照コマンド
このコマンドを使用します... | 次を行うには... | WLSTの使用... |
---|---|---|
構成Beanまたは実行時Beanの階層を移動します。 |
オンラインまたはオフライン |
|
階層内の現在の場所を返します。 |
オンライン |
|
プロンプトでパス情報の表示を切り替えます。 |
オンラインまたはオフライン |
|
階層内の現在の場所を表示します。 |
オンラインまたはオフライン |
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プロンプトを非表示にしたり表示したりします。有効な値は
|
例
次の例では、プロンプトでパス情報を非表示にしてから再表示します。
wls:/mydomain/serverConfig/Servers/myserver> prompt()
wls:/> prompt()
wls:/mydomain/serverConfig/Servers/myserver>
次の例では、プロンプトを非表示にして、デフォルトでJythonプロンプトを表示し(WLSTオンラインを使用してコマンドを実行している場合)、Jythonプロンプトを変更してから、WLSTプロンプトを再表示します。この例では、pwd
コマンドの使い方も示しています。
ノート:
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'
制御コマンド
-
サーバーに接続したり、サーバーへの接続を切断したりします(
connect
およびdisconnect
コマンド) -
構成ウィザードと同様に、ドメイン・テンプレートから新しいWebLogicドメインを作成します(
createDomain
、readTemplate
、writeDomain
およびcloseTemplate
コマンド) -
既存のWebLogicドメインをオフラインで更新します(
readDomain
、addTemplate
,、updateDomain
およびcloseDomain
コマンド) -
ドメイン・テンプレートを記述します(
writeTemplate
コマンド) -
WLSTを終了します
表2-3 WLST構成の制御コマンド
このコマンドを使用します... | 次を行うには... | WLSTの使用... |
---|---|---|
新しいサーバー起動グループを追加します。 |
オフライン |
|
アプリケーションまたはサービスの拡張テンプレートを使用して、現在のWebLogicドメインを拡張します。 |
オフライン |
|
サーバー・オブジェクトのクローンを作成します。 |
オフライン |
|
現在のドメインを閉じます。 |
オフライン |
|
現在のドメイン・テンプレートを閉じます。 |
オフライン |
|
WLSTをWebLogic Serverインスタンスに接続します。 |
オンラインまたはオフライン |
|
指定されたテンプレートを使用して新しいWebLogicドメインを作成します。 |
オフライン |
|
サーバー起動グループを削除します。 |
オフライン |
|
WLSTをWebLogic Serverインスタンスから接続解除します。 |
オンライン |
|
WLSTを対話セッションから終了させて、スクリプト・シェルを閉じます。 |
オンラインまたはオフライン |
|
ドメイン・パーティションをパーティション・アーカイブにエクスポートします。 |
オンライン |
|
データベースに接続してスキーマ情報を取得します。 |
オフライン |
|
ドメインのフロントエンド・ホストのプレーンURL、SSL URLまたはデフォルトURLを取得します。 |
オフライン |
|
指定されたサーバーがメンバーとなっているサーバー・グループのリストを取得します。 |
オフライン |
|
サーバー起動グループを取得します。 |
オフライン |
|
ドメインのドメイン・トポロジ・プロファイルを返します。 |
オフライン |
|
パーティション・アーカイブからドメイン・パーティションをインポートします。 |
オンライン |
|
ユーザーが展開可能なconfig-groups.xmlサーバー・グループのマップを取得します。 |
オフライン |
|
選択テンプレートを使用して、すべての選択されたテンプレートをロードします。 |
オフライン |
|
更新する既存のWebLogicドメインを開きます。 |
オフライン |
|
再構成のために既存のドメインを開きます。 |
オフライン |
|
ドメインを作成するために既存のドメイン・テンプレートを開きます。 |
オフライン |
|
テンプレートを更新するために既存のドメイン・テンプレートを開きます。 |
オフライン |
|
サービスを中断せずにターゲット・サーバーの指定されたアプリケーションの更新をロールアウトします。 |
オンライン |
|
サービスを中断せずに新しいJavaホームをターゲット・サーバーにロールアウトします。 |
オンライン |
|
サービスを中断せずにパッチを適用したOracleホームをターゲット・サーバーにロールアウトします。 |
オンライン |
|
サービスを中断せずにターゲット・サーバーのローリング再起動を開始します。 |
オンライン |
|
サービスを中断せずに更新をターゲット・サーバーにロールアウトします。 |
オンライン |
|
ドメインを作成するための既存のカスタム・ドメイン・テンプレートまたはアプリケーション・テンプレートを選択します。 |
オフライン |
|
ドメインを作成するための既存のドメイン・テンプレートまたはアプリケーション・テンプレートを選択します。 |
オフライン |
|
ドメインのフロントエンド・ホストのプレーンURL、SSL URLおよびデフォルトURLを設定します。 |
オフライン |
|
指定されたサーバーのサーバー・グループを設定します。 |
オフライン |
|
共有シークレット・ストアおよびパスワードを設定します。 |
オフライン |
|
サーバー起動グループを設定します。 |
オフライン |
|
ドメイン・トポロジ・プロファイルを設定します。 |
オフライン |
|
ロード用のすべての現在選択されているテンプレートを表示します。 |
オフライン |
|
すべての現在選択されているおよびロードされたテンプレートを表示します。 |
オフライン |
|
選択されたカスタム・ドメイン・テンプレートまたはアプリケーション・テンプレートを選択解除します。 |
オフライン |
|
選択されたドメイン・テンプレートまたはアプリケーション・テンプレートを選択解除します。 |
オフライン |
|
現在のドメインを更新して保存します。 |
オフライン |
|
ドメイン構成を検証します。 |
オフライン |
|
指定されたディレクトリにドメインの構成情報を書き込みます。 |
オフライン |
|
指定されたドメイン・テンプレート・ファイルに構成情報を書き込みます。 |
オンラインおよびオフライン |
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ドメインを拡張します。テンプレート・ビルダーを使用してアプリケーション・テンプレートまたはサービスの拡張テンプレートを作成します。ドメイン・テンプレート・ビルダーを使用したドメイン・テンプレートの作成のDomain Template Builderを使用した拡張テンプレートの作成を参照してください。
エラーが発生した場合は、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 |
クローンを作成するオブジェクトのタイプ。現在サポートされている唯一のタイプは |
例
次の例では、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
『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 |
オプション。サーバー・インスタンスのリスン・アドレスとリスン・ポート。 |
userConfigFile |
オプション。暗号化されたユーザー名とパスワードを格納するユーザー構成ファイルの名前と場所。この引数には次の構文を使用します:
指定しない場合、WLSTはコマンドを上記のように処理します。 ユーザー構成ファイルの作成時に、 |
userKeyFile |
オプション。指定されたユーザー構成ファイルに関連付けられていて、そのファイルの復号化に使用されるキー・ファイルの名前と場所。この引数には次の構文を使用します:
指定しない場合、WLSTはコマンドを上記のように処理します。 「storeUserConfig」を参照してください。 |
adminServerName |
オプション。ドメインの管理サーバーの名前。connectコマンドで、管理サーバーの
この引数は、WLSTをドメイン・ディレクトリから起動した場合にのみ有効となります。管理サーバーの 指定しない場合、WLSTはコマンドを上記のように処理します。 |
timeout |
オプション。オンライン・コマンドが完了する(返される)のをWLSTが待機するミリ秒数。 WLSTオンライン・コマンドを呼び出すと、WLSTはMBeanサーバーに接続してMBeanサーバー・メソッドを呼び出し、呼出しの結果を返します。MBeanサーバー・メソッドがタイムアウト期間内に返されない場合、WLSTは呼出しを破棄します。この引数には次の構文を使用します:
デフォルト値は0で、操作がタイムアウトしないことを示します。ただし、5分のタイムアウトが異なる層で発生する場合があることに注意してください。 |
idd |
オプション。ユーザーのアイデンティティ・ドメイン。この引数では次の構文を使用します。ここでは
この引数のデフォルトは |
例
次の例では、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コマンドで説明されているように、unpack
コマンドに類似した機能を備えています。
エラーが発生した場合は、WLSTException
が返されます。
構文
createDomain(domainTemplate, domainDir, user, password, topologyProfile)
引数 | 定義 |
---|---|
domainTemplate |
作成するドメインの基になるドメイン・テンプレートの名前および場所。 |
domainDir |
ドメイン構成情報を書き込むディレクトリの名前。 使用する環境のすべてのドメインをミドルウェア・ホーム・ディレクトリ以外の場所に作成することをお薦めします。これによって、ドメインやアプリケーションを再作成せずに、既存のインストールの削除や新しいバージョンのWebLogic Serverのインストールが簡単にできるようになります。 |
user |
デフォルト・ユーザーの名前。 |
password |
デフォルト・ユーザーのパスワード。 |
topologyProfile |
ドメインのトポロジ・プロファイルとして |
例
次の例では、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 |
オプション。アクティブなセッションの完了を待たずに接続を解除するかどうかを指定するブール値。この引数のデフォルトは |
例
次の例では、実行中のサーバーから接続を解除します。
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 |
オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値は |
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])
引数 | 定義 |
---|---|
|
エクスポートするパーティションの名前。 |
|
パーティション・アーカイブを保存するディレクトリへのフルパス。パスは管理サーバーによってアクセス可能である必要があります。アーカイブ・ファイルは |
|
オプション。 |
|
オプション。パーティション・アーカイブ内の属性を暗号化するための暗号化キーとして使用する文字列を含むファイルへのフルパス。パスは管理サーバーによってアクセス可能である必要があります。この引数のデフォルトは内部キーを使用します。 |
例
次の例では、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 |
次のいずれかのタイプを指定します。
|
例
次の例では、ドメイン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])
引数 | 定義 |
---|---|
|
インポートするパーティション・アーカイブのフルパス。パスは管理サーバーによってアクセス可能である必要があります。 |
|
オプション。新規ドメインに作成されるときにパーティションに使用する名前。デフォルトはそのパーティションの元の名前です。 |
|
オプション。リソース・グループ・テンプレートの競合の処理方法を制御します。パーティションで使用されるすべてのリソース・グループ・テンプレートはパーティション・アーカイブに含まれ、パーティションとともにドメインにインポートされます。 リソース・グループ・テンプレートがすでにドメインに存在し、この引数が |
|
オプション。パーティション・アーカイブ内の属性を復号化するための暗号化キーとして使用する文字列を含むファイルへのフルパスパスは管理サーバーによってアクセス可能である必要があります。この引数のデフォルトは内部キーを使用します。 |
例
次の例では、/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 |
オプション。 |
例
次の例では、サーバー・グループを、プログラムで使用される形式で出力します。
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で定義されたプロパティ。これには、 |
例
次の例では、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のトポロジ・プロファイル( ノート: この引数は、スタンドアロンでインストールされたシステム・コンポーネント(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を次の形式で設定します。
|
ssl |
フロントエンド・ホストのSSL URLを次の形式で設定します。
ノート: フロントエンド・ホストのプレーンURLを使用している場合は引き続きデフォルトのSSL URLを指定する必要があります。フロントエンド・ホストにプレーン接続のみを設定している場合、プレーンとSSLに同じURLを使用できます。それ以外の場合は、異なる必要があります。 |
isPlainDefault |
ブール値。 |
例
次の例では、ドメイン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 |
オプション。オンライン・モードで |
skipEdit |
オプション。オンライン・モードで |
例
次の例では、サーバー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(templateName, [timeout])
引数 | 定義 |
---|---|
templateName |
ドメイン構成情報を格納するドメイン・テンプレートの名前。 |
timeout |
オプション。オンライン・モードで |
例
次の例では、現在のドメイン構成を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としてドメイン・トポロジ・プロファイルを設定します。
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 |
オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、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 |
オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、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, isRollback, [options])
引数 | 定義 |
---|---|
target |
ロールアウトが有効になるドメイン、クラスタまたはカンマ区切りリストのサーバーの名前。 |
rolloutOracleHome |
既存のOracleホームを置き換える、ロールアウトするOracleホームのバージョンを含むアーカイブまたはローカル・ディレクトリの場所。 |
backupOracleHome |
既存のOracleホームを移動するローカル・ディレクトリのパス。 |
isRollback |
ブール値。ユーザーがドメインにロールアウトする変更を以前のパッチ・リリースのOracleホームに指定することを許可します。この情報は、管理サーバーを最初または最後に更新する必要があるかどうかを決定する場合に重要です。 ロールアウトするOracleホームが現在のOracleホームより古いパッチ・バージョンを含む場合、 |
options |
オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、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 |
オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、一度に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, isRollback], [javaHomeDirectory], [applicationPropertiesFile], [options])
引数 | 定義 |
---|---|
target |
ロールアウトが有効になるドメイン、クラスタ、またはカンマ区切りリストでのサーバーの名前。 |
rolloutOracleHome |
既存のOracleホームを置き換える、ロールアウトするOracleホームのバージョンを含むアーカイブまたはローカル・ディレクトリの場所。 「rolloutOracleHome」を参照してください。 |
backupOracleHome |
既存のOracleホームを移動するローカル・ディレクトリのパス。 「rolloutOracleHome」を参照してください。 |
javaHomeDirectory |
Javaホームを更新する場合、この引数を指定する必要があります。 「rolloutOracleHome」を参照してください。 |
applicationPropertiesFile |
サーバーにデプロイされたアプリケーションを更新する場合、この引数を指定する必要があります。 「rolloutApplications」を参照してください。 |
isRollback |
Oracleホームを更新する場合、この引数を指定する必要があります。 「rolloutOracleHome」を参照してください。 |
options |
オプション。オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、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 |
オプション。非表示のテンプレートを表示します。デフォルト値は |
verbose |
オプション。完全なテンプレートの場所のパスを表示します。デフォルト値は |
includeApplied |
オプション。適用されたテンプレートを表示します。デフォルト値は |
例
wls:/offline> showAvailableTemplates('false','true','false')
カスタマイズ・コマンド
help()
およびhelp('
commandGroup
')
コマンドで示すコマンド・グループ・ヘルプおよびコマンド・ヘルプを追加します。表2-4に、これらのコマンドをリストしてまとめてあります。『WebLogic Scripting Toolの理解』のカスタム・コマンドの統合ヘルプの追加に関する項を参照してください。
表2-4 WLST構成のカスタマイズ・コマンド
コマンド | 説明 | WLSTの使用... |
---|---|---|
WLST |
オンラインまたはオフライン |
|
コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、 |
オンラインまたはオフライン |
addHelpCommandGroup
コマンド・カテゴリ: カスタマイズ・コマンド
WLSTでの使用: オンラインまたはオフライン
説明
WLST help()
コマンドで表示されているグループに新しいコマンド・ヘルプ・グループを追加して、グループに対して定義されているヘルプ情報のリソース・バンドルを指定します。
構文
addHelpCommandGroup(commandGroup, resourceBundleName)
引数 | 定義 |
---|---|
commandGroup |
コマンド・グループの一意の名前を使用します。WLST |
resourceBundleName |
クラス名またはプロパティ・リソース・ファイル名を表します。リソース・バンドルには、標準パターンを使用したコマンド・グループのエントリのヘルプ・テキストが格納されます。リソース・バンドル名が リソース・バンドルは、クラスパスに指定されている必要があります。 各コマンド・グループおよびコマンドのヘルプ・テキストの定義方法については、WebLogic Scripting Toolの理解のカスタム・コマンドの統合型ヘルプの追加を参照してください。 resourceBundleおよびローカライゼーションについては、 |
例
次の例では、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 |
オプション。コマンドを |
offline |
オプション。コマンドを |
例
次の例では、オンライン・コマンドbootDB
をhelp('boot')
およびhelp('online')
コマンドで示される出力に追加する方法を示します。
wls:/offline> addHelpCommand('bootDB','boot',online='true',offline='false')
デプロイメント・コマンド
『Oracle WebLogic Serverへのアプリケーションのデプロイ』のWebLogic Serverデプロイメントの理解に関する項を参照してください。
表2-5 WLST構成のデプロイメント・コマンド
コマンド | 説明 | WLSTの使用... |
---|---|---|
WebLogic Serverインスタンスにアプリケーションをデプロイします。 |
オンライン |
|
指定されたターゲットにデプロイメント・バンドルをコピーします。 |
オンライン |
|
WebLogic |
オンライン |
|
WebLogicドメイン内に現在デプロイされているすべてのアプリケーションをリストします。 |
オンライン |
|
アプリケーションとデプロイメント・プランをメモリーにロードします。 |
オンラインおよびオフライン |
|
以前にデプロイされたアプリケーションを再デプロイします。 |
オンライン |
|
アプリケーションを起動して、ユーザーが利用できるようにします。 |
オンライン |
|
アプリケーションを停止して、ユーザーが利用できないようにします。 |
オンライン |
|
指定されたサーバーからアプリケーションをアンデプロイします。 |
オンライン |
|
新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。 |
オンライン |
|
コード・ソースjarをターゲットに配布し、それを使用してWebLogic Extension Loaderを拡張します。 |
オンライン |
deploy
コマンド・カテゴリ: デプロイメント・コマンド
WLSTでの使用: オンライン
説明
WebLogic Serverインスタンスにアプリケーションをデプロイします。
deploy
コマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgress
オブジェクトを返します。『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTException
が返されます。
ノート:
進行中の編集セッションがある場合、deploy
コマンドはユーザーの対話をブロックしません。
構文
deploy(appName, path, [targets], [stageMode], [planPath], [resourceGroup], [resourceGroupTemplate], [partition], [options])
引数 | 定義 |
---|---|
appName |
デプロイするスタンドアロンJava EEモジュールまたはアプリケーションの名前。 |
path |
デプロイするアプリケーション・ディレクトリ、アーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。 |
targets |
オプション。対象のカンマ区切りのリスト。各ターゲットをJava EEモジュール名で修飾できます(たとえば、 |
stageMode |
オプション。デプロイするアプリケーションのステージング・モード。有効な値は |
planPath |
オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリの |
resourceGroup |
オプション。このデプロイメントをスコープ指定するリソース・グループの名前。パーティション・リソース・グループまたはドメイン・リソース・グループにデプロイする場合、リソース・グループを指定します。 |
resourceGroupTemplate |
オプション。このデプロイメントをスコープ指定するリソース・グループ・テンプレートの名前。 |
partition |
オプション。このデプロイメントをスコープ指定するパーティションの名前。引数が指定されない場合、パーティション名は現在の起動コンテキストから導出されます。 |
options |
オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
options (続き) |
|
例
次の例では、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>
『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
オブジェクトを返します。『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTException
が返されます。
構文
distributeApplication(appPath, [planPath], [targets], [resourceGroup], [resourceGroupTemplate], [partition], [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>
『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。
appendToExtensionLoader
コマンド・カテゴリ: デプロイメント・コマンド
WLSTでの使用: オンライン
説明
コード・ソースjarをターゲットに配布し、それを使用してWebLogic Extension Loaderを拡張します。
構文
appendToExtensionLoader([options])
引数 | 定義 |
---|---|
options |
このコマンドは次のオプションをサポートしています。 targets - サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値は、 source - 配布するコード・ソースjarを指定します。 upload - 配布前に、指定したコード・ソースjarを管理サーバーに転送します。 このオプションは、リモート・マシンで作業している場合で、他の手段でコード・ソースjarを管理サーバーにコピーできない場合に使用します。 配布の前に、コード・ソースjarはWebLogic管理サーバーのアップロード・ディレクトリにアップロードされます。 |
例
次の例では、コード・ソースjarをCluster-1
内の管理対象サーバーに配布し、稼働中サーバーのためにjarをWebLogic Extension Loaderのクラス検索スペースに追加します。
appendToExtensionLoader(source=’custom.jar’, targets='Cluster-1’)
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
オブジェクトを返します。『WebLogic Scripting Toolの理解』のWLSTPlanオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTException
が返されます。
ノート:
loadApplication
コマンドは、リモート・マシンからのアプリケーションのロードをサポートしません。アプリケーションは、管理サーバーが実行されているのと同じマシンにある必要があります。
構文
loadApplication(appPath, [planPath], [createPlan])
引数 | 定義 |
---|---|
appPath |
ロードするアプリケーションが含まれている、最上位の親アプリケーション・ディレクトリ、アーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。ターゲット・アプリケーション・ディレクトリは、管理サーバーが配置されているのと同じマシンにある必要があります。 |
planPath |
オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリの |
createPlan |
オプション。指定されたプランが存在しない場合に、WLSTがアプリケーション・ディレクトリにプランを作成するかどうかを指定するブール値。この引数のデフォルトは |
例
次の例では、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
『WebLogic Scripting Toolの理解』のWLSTPlanオブジェクトに関する項を参照してください。
redeploy
コマンド・カテゴリ: デプロイメント・コマンド
WLSTでの使用: オンライン
説明
クラスを再ロードして、以前にデプロイされたアプリケーションを再デプロイします。
redeploy
コマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgress
オブジェクトを返します。『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
『Oracle WebLogic Serverへのアプリケーションのデプロイ』の一般的なデプロイメント・シナリオの概要に関する項を参照してください。
構文
redeploy(appName, [planPath], [resourceGroupTemplate], [partition], [removePlanOverride], [options])
例
次の例では、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>
『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。
startApplication
コマンド・カテゴリ: デプロイメント・コマンド
WLSTでの使用: オンライン
説明
アプリケーションを起動して、ユーザーが利用できるようにします。アプリケーションは完全に構成済で、WebLogicドメインで利用できる状態でなければなりません。
startApplication
コマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgress
オブジェクトを返します。『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTException
が返されます。
構文
startApplication(appName, [partition], [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>
『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。
stopApplication
コマンド・カテゴリ: デプロイメント・コマンド
WLSTでの使用: オンライン
説明
アプリケーションを停止して、ユーザーが利用できないようにします。アプリケーションは完全に構成済で、WebLogicドメインで利用できる状態でなければなりません。
stopApplication
コマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgress
オブジェクトを返します。『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
stopApplication(appName, [partition], [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>
『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。
undeploy
コマンド・カテゴリ: デプロイメント・コマンド
WLSTでの使用: オンライン
説明
指定されたサーバーからアプリケーションをアンデプロイします。
undeploy
コマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgress
オブジェクトを返します。『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTException
が返されます。
『Oracle WebLogic Serverへのアプリケーションのデプロイ』の一般的なデプロイメント・シナリオの概要に関する項を参照してください。
構文
undeploy(appName, [targets], [resourceGroupTemplate], [partition], [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
オブジェクトを返します。『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTException
が返されます。
構文
updateApplication(appName, [planPath], [resourceGroupTemplate], [partition], [removePlanOverride], [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>
『WebLogic Scripting Toolの理解』のWLSTProgressオブジェクトに関する項を参照してください。
診断コマンド
表2-6 WLST構成の診断コマンド
コマンド | 説明 | WLSTの使用... |
---|---|---|
指定されたターゲットのデバッグ・パッチをアクティブ化します。 |
オンライン |
|
診断イメージを取得し、クライアントにダウンロードします。 |
オンライン |
|
指定されたディスクリプタ・ファイルを使用して診断システム・リソース管理を作成します。 |
オンライン |
|
指定されたターゲットのすべてのデバッグ・パッチを非アクティブ化します。 |
オンライン |
|
指定されたターゲットのデバッグ・パッチを非アクティブ化します。 |
オンライン |
|
診断システム・リソース管理を破棄します。 |
オンライン |
|
サーバー・インスタンスでアクティブ化されている診断システム・リソース管理を非アクティブ化します。 |
オンライン |
|
特定のWLDFシステム・リソースのハーベスタ構成に一致するライブ・データをポーリングし、ローカル・ファイルにダンプします。 |
オンライン |
|
サーバー・インスタンスで診断システム・リソースをアクティブ化します。 |
オンライン |
|
指定されたログ・ファイルに対する問合せを実行します。 |
オフライン |
|
サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。 |
オンライン |
|
CSV形式で指定された間隔内に収集されたメトリック・データをエクスポートします。 |
オンライン |
|
CSV形式で指定された間隔内にオフライン・モードで収集されたメトリック・データをエクスポートします。 |
オフライン |
|
以前に取得した診断イメージのリストを返します。 |
オンライン |
|
サーバーまたはパーティションで現在使用できる診断データ・アクセサ名を取得します。 |
オンライン |
|
指定されたターゲットのアクティブな使用できるデバッグ・パッチをリストします。 |
オンライン |
|
指定されたターゲットからデバッグ・パッチ・タスクをリストします。 |
オンライン |
|
現在サーバー・インスタンスにデプロイされている診断システム・リソースをリストします。 |
オンライン |
|
データ・ファイルのセットをマージします。 |
オンライン |
|
指定された期間の基準に従って、サーバーの診断イメージ・ファイルをパージします。 |
オンライン |
|
指定されたターゲットからデバッグ・パッチ・タスクをパージします。 |
オンライン |
|
指定されたターゲットのデバッグ・パッチの詳細を表示します。 |
オンライン |
|
指定された診断イメージ・キャプチャをダウンロードします。 |
オンライン |
|
診断イメージ・キャプチャから特定のエントリをダウンロードします。 |
オンライン |
activateDebugPatch
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
指定されたターゲットのデバッグ・パッチをアクティブ化します。管理サーバーの接続中に、オプションのtargetパラメータを指定して、複数の管理対象サーバーおよびクラスタのデバッグ・パッチをアクティブ化できます。targetパラメータを指定しない場合、デバッグ・パッチは接続されたサーバーでのみアクティブ化されます。
activateDebugPatch
コマンドは、タスクの配列を返します。各要素は、影響を受けるターゲット・サーバー・インスタンスのアクティブ化アクティビティに対応します。
構文
activateDebugPatch(patch, [options])
引数 | 説明 |
---|---|
|
アクティブ化するデバッグ・パッチの名前。パッチは、適用可能なターゲット・サーバーに存在する必要があります。 |
|
app - 指定されたアプリケーションのスコープ内でデバッグ・パッチをアクティブ化します。指定しない場合、デバッグ・パッチはシステム・レベルでアクティブ化されます。デフォルト値は module - アプリケーションの指定されたモジュールのスコープ内でデバッグ・パッチをアクティブ化します。 partition— 指定されたパーティションのスコープ内でデバッグ・パッチをアクティブ化します。 target - 管理サーバーのみ。デバッグ・パッチがアクティブ化される場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値は |
例
次の例では、クラスタmyCluster
、パーティションmyPartition
、アプリケーションmyapp
のスコープ内でdyndebug_app01.jar
デバッグ・パッチをアクティブ化します。
wls:/dyndebugDomain/serverConfig> tasks=activateDebugPatch('dyndebug_app01.jar', app='myapp', partition='myPartition', target='myCluster')
captureAndSaveDiagnosticImage
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
診断イメージを取得し、クライアントにダウンロードします。
構文
captureAndSaveDiagnosticImage([options])
引数 | 説明 |
---|---|
|
このコマンドは次のオプションをサポートしています。
|
例
次の例では、クラスタ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 |
診断リソースの名前。 ノート: リソースは、 |
descriptorFile |
診断ディスクリプタ・ファイルへのローカル・パス。 |
options |
Server - 管理サーバーのみ。ターゲット・サーバー名。デフォルト値は Target - サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値は enabled - |
例
次の例では、サーバー・ターゲット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 |
オプション。管理サーバーのみ。デバッグ・パッチが非アクティブ化される場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値は |
例
次の例では、クラスタmyCluster
のすべてのデバッグ・パッチを非アクティブ化します。
wls:/dyndebugDomain/serverConfig> tasks=deactivateAllDebugPatches(target='myCluster')
deactivateDebugPatches
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
指定されたターゲットのデバッグ・パッチを非アクティブ化します。管理サーバーの接続中に、オプションのtarget
パラメータを指定して、複数の管理対象サーバーおよびクラスタのデバッグ・パッチを非アクティブ化できます。target
パラメータを指定しない場合、接続されたサーバーのデバッグ・パッチのみが非アクティブ化されます。
deactivateDebugPatches
コマンドは、タスクの配列を返します。各要素は、影響を受けるターゲット・サーバー・インスタンスの非アクティブ化アクティビティに対応します。
構文
deactivateDebugPatches(patches, [options])
引数 | 説明 |
---|---|
|
非アクティブ化するデバッグ・パッチのカンマ区切りリスト。 |
|
app - 指定されたアプリケーションのスコープ内でデバッグ・パッチを非アクティブ化します。指定しない場合、デバッグ・パッチはシステム・レベルで非アクティブ化されます。デフォルト値は module - アプリケーションの指定されたモジュールのスコープ内でデバッグ・パッチを非アクティブ化します。 partition— 指定されたパーティションのスコープ内でデバッグ・パッチを非アクティブ化します。 target - 管理サーバーのみ。デバッグ・パッチが非アクティブ化される場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値は |
例
次の例では、クラスタ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 |
診断リソースの名前。 ノート: リソースは、 |
options |
Server - 管理サーバーのみ。リソースが現在デプロイされているサーバーの名前。デフォルト値は Target - リソースが現在デプロイされているサーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値は |
例
次の例では、myserver
サーバーにデプロイされていたmyExternalResource
という診断システム・リソース管理を破棄します。
wls:/mydomain/serverRuntime>destroySystemResourceControl('myExternalResource', Target='myserver')
disableSystemResource
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
サーバー・インスタンスで有効になっている診断システム・リソース管理を非アクティブ化します。
構文
disableSystemResource(resourceName, [options])
引数 | 定義 |
---|---|
resourceName |
診断リソースの名前。 ノート: リソースは、 |
options |
Server - 管理サーバーのみ。ターゲット・サーバー名。デフォルト値は Target - サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値は |
例
次の例では、myserver
サーバーでアクティブ化されているmySystemResource
という診断システム・リソースを非アクティブ化します。
wls:/mydomain/serverRuntime>disableSystemResource('mySystemResource',Target='myserver')
dumpDiagnosticData
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
特定のWLDFシステム・リソースのハーベスタ構成に一致するライブ診断データを、指定した頻度および期間でポーリングし、ローカル・ファイルにダンプします。データはCSV形式で書き込まれます。
連続するサンプリング期間の間で収集されたデータ・セットに変更が検出された場合は、新しい出力ファイルが作成され、情報メッセージが表示されます。サンプリング間隔が特に長いと、複数の出力ファイルが作成されることがあります。これらのデータ・ファイルは、mergeDiagnosticData
コマンドを使用してマージできます。
構文
dumpDiagnosticData(resourceName, filename, frequency, duration, [options])
引数 | 定義 |
---|---|
resourceName |
データのポーリング元となるシステム・リソースの名前。 ノート: リソースは、 |
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 - 管理サーバーのみ。ターゲット・サーバー名。デフォルト値は Target - サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値は |
例
次の例では、myServer
サーバーの診断システム・リソースmySystemResource
をアクティブ化します。
wls:/mydomain/serverRuntime>enableSystemResource('mySystemResource',Target='myserver')
exportDiagnosticData
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オフライン
説明
指定されたログ・ファイルに対する問合せを実行します。結果はXML、CSVまたはTXTファイルとして保存されます。デフォルトの出力形式はXMLです。
Oracle WebLogic Server診断フレームワークの構成と使用のData Accessorによる診断データへのアクセスを参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
exportDiagnosticData([options])
引数 | 説明 |
---|---|
options |
オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、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です。このコマンドには、管理対象サーバーへのセキュアな接続を持っていることが必要です。
Oracle WebLogic Server診断フレームワークの構成と使用のData Accessorによる診断データへのアクセスを参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
exportDiagnosticDataFromServer([options])
引数 | 定義 |
---|---|
|
オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、HTTPAccessLog
に対して問合せを実行し、その結果をmyExport.xml
というファイルに格納します。
wls:/mydomain/serverRuntime> exportDiagnosticDataFromServer(logicalName="HTTPAccessLog", exportFileName="myExport.xml")
exportHarvestedTimeSeriesData
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
特定のサーバー・スコープ指定またはパーティション・スコープ指定のWLDFシステム・リソースの診断アーカイブから収集されたメトリック・データをエクスポートします。
『Oracle WebLogic Server診断フレームワークの構成と使用』の「メトリック収集用のハーベスタの構成」を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
exportHarvestedTimeSeriesData(wldfSystemResource, [options])
引数 | 定義 |
---|---|
|
収集されたデータをエクスポートするWLDFシステム・リソースの名前。 |
|
エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、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 |
オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:
|
例
次の例では、オフライン・モードでWLDFシステム・リソースwldf-1
から収集された診断データをエクスポートし、データをexport.csv
というファイルに書き込みます。
wls:/offline> exportHarvestedTimeSeriesDataOffline(wldfSystemResource='wldf-1')
Opening new capture file export.csv ...
getAvailableCapturedImages
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
サーバーで構成したイメージの宛先ディレクトリに格納される以前に捕捉した診断イメージのリストを文字列の配列で戻します。デフォルトのディレクトリはSERVER
\logs\diagnostic_images
です。
このコマンドは、ダウンロードする診断イメージ・キャプチャの識別または特定のエントリをダウンロードする診断イメージ・キャプチャの識別に役立ちます。
『Oracle WebLogic Server診断フレームワークの構成と使用』の「診断イメージの構成とキャプチャ」を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
getAvailableCapturedImages([options])
引数 | 定義 |
---|---|
|
server - (管理サーバーのみ)使用可能なイメージのリストの取得元となるサーバー。デフォルト値は 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])
引数 | 定義 |
---|---|
|
server— 使用できるデータ・アクセサ名のリストを取得するサーバー。指定しない場合、データは、WLSTを接続している現在のサーバーから取得されます。このオプションは、WLSTが管理サーバーに接続している場合にのみ適用できます。デフォルト値は 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 - 管理サーバーのみ。システム・リソース管理の表示元となるターゲット・サーバー名。デフォルト値は Target - システム・リソース管理の表示元となるサーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。デフォルト値は |
例
次の例では、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 - マージされたターゲット・データ・ファイルの名前。デフォルトは |
例
この例では、/home/mydir/dataディレクトリにあるすべてのデータ・ファイルを1つのデータ・ファイルmymergedata.csv
にマージします。
wls:/mydomain/serverRuntime>mergeDiagnosticData('/home/mydir/data', toFile='mymergedata.csv')
purgeCapturedImages
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
サーバーで構成したイメージの宛先ディレクトリから指定された期間の基準に従って、サーバーの診断イメージ・ファイルをパージします。
エラーが発生した場合は、WLSTException
が返されます。
構文
purgeCapturedImages([options])
引数 | 定義 |
---|---|
|
server - 管理サーバーのみ。使用可能なイメージのリストをパージするサーバーの名前。指定しない場合、デフォルトの partition— 診断イメージをパージするパーティションの名前。指定しない場合は、サーバー上のすべてのイメージがパージされます。指定しない場合、デフォルトの age— 指定された有効期間より古い診断イメージがパージされます。有効期間は形式 |
例
次の例では、管理対象サーバーMS1
、パーティションtestPartition
から15日12時間30分より古いイメージをパージします。
wls:/mydomain/serverConfig> purgeCapturedImages("15:12:30", server="MS1", partition="testPartition")
purgeDebugPatchTasks
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
指定されたターゲットのデバッグ・パッチ(アクティブ化または非アクティブ化)・タスクをパージします。管理サーバーの接続中に、オプションのtarget
パラメータを指定して、複数の管理対象サーバーおよびクラスタのタスクをパージできます。target
パラメータを指定しない場合、接続されたサーバーのタスクのみがパージされます。完了後、失敗したまたは取り消されたタスクのみがパージされます。
構文
purgeDebugPatchTasks([target])
引数 | 定義 |
---|---|
target |
オプション。管理サーバーのみ。デバッグ・パッチ・タスクがパージされる場合のサーバー名、クラスタ名または両方のカンマ区切りのリスト。デフォルト値は |
例
次の例では、クラスタmyCluster
からデバッグ・パッチ・タスクをパージします。
wls:/dyndebugDomain/serverConfig> tasks=purgeDebugPatchTasks(target='myCluster')
showDebugPatchInfo
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
指定されたターゲットのデバッグ・パッチの詳細を表示します。管理サーバーの接続中に、オプションのtarget
パラメータを指定して、複数の管理対象サーバーおよびクラスタのデバッグ・パッチ情報を表示できます。表示される情報には、デバッグ・パッチに存在する場合にREADMEファイルの内容とともにデバッグ・パッチの内容が含まれます。
構文
showDebugPatchInfo(patch, [target])
引数 | 定義 |
---|---|
patch |
情報を表示するデバッグ・パッチの名前。 |
target |
オプション。管理サーバーのみ。サーバー名またはクラスタ名、あるいはその両方のカンマ区切りのリスト。指定しない場合、接続されたサーバーのデバッグ・パッチ情報のみが表示されます。デフォルト値は |
例
次の例では、クラスタ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が現在接続されているサーバーから指定した診断イメージ・キャプチャをダウンロードします。
『Oracle WebLogic Server診断フレームワークの構成と使用』の「診断イメージの構成とキャプチャ」を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
saveDiagnosticImageCaptureFile(imageName, [Server], [outputFile], [partition])
引数 | 定義 |
---|---|
|
ダウンロードする診断イメージ・キャプチャの名前。 |
|
Server - 管理サーバーのみ。イメージの取得元となるサーバーの名前。管理サーバーに接続して管理対象サーバーからイメージを取得する際には、適切なServer引数を指定する必要があります。指定しない場合、デフォルトの outputFile - 取得した診断イメージ・キャプチャを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトで 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が現在接続されているサーバーにある診断イメージ・キャプチャから特定のエントリをダウンロードします。
『Oracle WebLogic Server診断フレームワークの構成と使用』の「診断イメージの構成とキャプチャ」を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
saveDiagnosticImageCaptureEntryFile(imageName, imageEntryName, [Server], [outputFile], [partition])
引数 | 定義 |
---|---|
|
任意のエントリを含む診断イメージ・キャプチャの名前。 |
|
診断イメージ・キャプチャから取得する特定のエントリの名前。これは、次のいずれかです。 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 |
|
管理サーバーのみ。イメージ・エントリの取得元となるサーバー。管理サーバーに接続して管理対象サーバーからイメージ・エントリを取得する際には、適切な |
|
オプション。診断イメージ・キャプチャから取得したエントリを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトで |
|
オプション。イメージ・エントリを取得するパーティションの名前。 |
例
次の例では、診断イメージ・キャプチャのリストを取得し、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
編集コマンド
ノート:
構成Beanを編集するには、管理サーバーに接続している必要があります。また、編集ツリーに移動して、編集セッションを開始する必要があります。「edit」および「startEdit」をそれぞれ参照してください。
管理対象サーバーに接続した場合、WLSTの機能は構成Bean階層の参照だけに制限されます。WLSTを使用して管理対象サーバー上のMBeanの値を変更することはできませんが、管理APIを使用すれば可能です。ただし、管理サーバー上の構成MBeanの値のみを変更することをお薦めします。管理対象サーバー上のMBeanの値を変更すると、ドメイン構成に矛盾が生じる可能性があります。
『WebLogic Scripting Toolの理解』のWLSTオンラインを使用した既存のドメインの更新に関する項を参照してください。
表2-7 WLST構成の編集コマンド
コマンド | 説明 | WLSTの使用... |
---|---|---|
現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。 |
オンラインまたはオフライン |
|
リソースを1つまたは複数の宛先に割り当てます。 |
オフライン |
|
編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。この操作は、その編集セッションを開始したユーザーでなくても、管理者権限を持つユーザーであれば誰でも呼び出すことができます。 |
オンライン |
|
現在のBeanに対して、指定されたタイプの構成Beanを作成します。 |
オンラインまたはオフライン |
|
新しい編集セッションを作成します。 |
オンライン |
|
現在の構成Beanの構成のインスタンスを削除します。 |
オンラインまたはオフライン |
|
ドメインのフロントエンド・ホストを削除します。 |
オフライン |
|
指定された編集セッションを削除します。 |
オンライン |
|
アクティブ化中にすべてのシステム・コンポーネントへの変更を上書きします。 |
オンライン |
|
指定された文字列を暗号化します。 |
オンライン |
|
指定された属性の値を返します。 |
オンラインまたはオフライン |
|
ユーザーがステータスを取得できる最新の |
オンライン |
|
現在の構成Beanの管理操作を呼び出します。 |
オンライン |
|
サーバーの再起動が必要かどうかを判断します。 |
オンライン |
|
SQLファイルをデータベースにロードします。 |
オフライン |
|
プロパティ値をファイルからロードします。 |
オンラインまたはオフライン |
|
リモート・ノードからシステム・コンポーネントの構成変更を抽出します。 |
オンライン |
|
外部の変更または競合を検出して解決します。 |
オンライン |
|
指定されたシステム・コンポーネントの構成ファイルを再同期します。 |
オンライン |
|
すべてのシステム・コンポーネントの構成ファイルを再同期します。 |
オンライン |
|
編集されてまだ保存されていない編集内容を保存します。 |
オンライン |
|
現在の構成Beanの指定された属性値を設定します。 |
オンラインまたはオフライン |
|
WebLogicドメインの作成または更新に関連するオプションを設定します。 |
オフライン |
|
現在の編集セッション中に現在のユーザーが行った構成の変更内容を表示します。 |
オンライン |
|
リモート・ノードの指定されたシステム・コンポーネントの構成への変更を表示します。 |
オンライン |
|
指定された編集セッションの情報を表示します。 |
オンライン |
|
現在接続しているユーザーのために構成編集セッションを開始します。 |
オンライン |
|
編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。 |
オンライン |
|
1つまたは複数の宛先からアプリケーションまたはリソースの割当てを解除します。 |
オフライン |
|
保存またはアクティブ化されていない編集をすべて元に戻します。 |
オンライン |
|
変更されてまだ保存されていない変更内容を検証します。 |
オンライン |
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がユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトは |
例
次の例では、現在の編集セッション中に変更され、ディスクに保存されていて、まだアクティブ化されていない変更内容をアクティブ化します。WLSTは構成の変更のアクティブ化が完了するのを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のタイプ。この値は、次のいずれかの値に設定できます。
この値の設定のガイドラインについては次を参照してください。 |
sourceName |
割り当てるリソースの名前。複数の名前をカンマで区切って指定することも、ワイルドカード(*)を使って指定されたタイプのすべてのリソースを指定することも可能です。 サブデプロイメントは ノート: |
destinationType |
宛先のタイプ。この値の設定のガイドラインについては次を参照してください。 |
destinationName |
宛先の名前。複数の名前をカンマで区切って指定できます。 JMSサービスを移行可能な管理対象サーバーに割り当てる場合などに、移行可能なターゲットを指定するには、宛先名の後ろに
|
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 |
オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値は |
例
次の例では、現在の編集セッションを取り消します。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のみを作成できます。『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のタイプ。 |
baseProviderType |
セキュリティ・プロバイダを作成する場合は、基本セキュリティ・プロバイダ・タイプ( |
例
次の例では、現在の構成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, [description])
引数 | 定義 |
---|---|
name |
編集セッションの名前または識別子。英数字、アンダースコア(_)およびダッシュ(-)を使用できます。 |
description |
オプション。ユーザーが簡単に識別するための編集セッションの説明。 |
例
次の例では、mySampleSession
という名前の編集セッションを作成し、作成するセッションの便利な説明を示します。
wls:/wls/serverConfig> createEditSession('mySampleSession', 'This session is created to test this command')
delete
コマンド・カテゴリ: 編集コマンド
WLSTでの使用: オンラインまたはオフライン
説明
現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。
エラーが発生した場合は、WLSTException
が返されます。
ノート:
現在の構成管理オブジェクト(cmo
)タイプの子である構成Beanのみを削除できます。『WebLogic Scripting Toolの理解』の現在の管理オブジェクトの変更に関する項を参照してください。
構文
delete(name, childMBeanType)
引数 | 定義 |
---|---|
name |
削除する子構成Beanの名前。 |
childMBeanType |
削除する構成Beanのタイプ。 |
例
次の例では、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 |
オプション。 |
例
次の例では、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('password','c:/Oracle/Middleware/domains/mydomain')
get
コマンド・カテゴリ: 編集コマンド
WLSTでの使用: オンラインまたはオフライン
説明
指定された属性の値を返します。表示できるMBean属性の詳細は、Oracle WebLogic Server MBeanリファレンスを参照してください。エラーが発生した場合は、WLSTException
が返されます。
ノート:
ls('a')
と入力すると、すべての属性とその現在の値を表示できます。「ls」を参照してください。
かわりに、cmo
変数を使用して、現在の構成Beanの任意のgetメソッドを実行できます。たとえば:
cmo.getListenPort()
『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 |
オプション。指定されたデータ・ソースに関連付けられるデータベース・カテゴリ。 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つ以上の競合が検出された場合に解決を決定するブール・フラグ。 |
例
次の例では、検出された競合をリストするresolve()
コマンドを呼び出します。このコマンドは、競合および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.set
attrName
(
value
)
たとえば、
set('ListenPort', 7011)
を使用するかわりに、次の構文を使用できます。cmo.setListenPort(7011)
『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 |
オプションの値。 ノート: ブール値は、文字列( |
オプション名 | 用途 | 説明 |
---|---|---|
|
ドメインの作成 |
WebLogicドメインの名前。デフォルトでは、WebLogicドメインの名前はドメイン・ディレクトリの名前から取られます。たとえば、WebLogicドメインが |
|
ドメインの作成 |
サーバーの起動時に使用するJVMのホーム・ディレクトリ。このオプションのデフォルトは、WebLogic Serverをインストールしているプラットフォームによって異なります。 |
|
ドメインの作成 |
ドメインのノード・マネージャを作成するときに使用するノード・マネージャ・タイプ。このオプションのデフォルトは
ノート: ドメインをアップグレードしてホストごとのノード・マネージャ構成からドメインごとのノード・マネージャ構成に変更する際に、カスタム・スクリプトを使用してWebLogic Server環境を起動および停止する場合、手動でスクリプトを更新してノード・マネージャ・ホームの場所を新しいドメインベースの場所に変更する必要があります。 『Oracle WebLogic Serverノード・マネージャ管理』の「Javaノード・マネージャの構成」を参照してください。 『Oracle WebLogic Serverノード・マネージャの管理』のノード・マネージャのデフォルト構成に関する項を参照してください |
|
ドメインの作成 |
ノード・マネージャ・ホームは、ドメインに作成されるノード・マネージャのディレクトリです。このオプションは、 |
|
ドメインの再構成 |
ドメインの再構成中、ノード・マネージャのアップグレードのために既存の構成が取得されるノード・マネージャ・ホーム・ディレクトリ。このオプションは、ノード・マネージャのアップグレード・タイプが |
|
ドメインの再構成 |
ノード・マネージャのアップグレードは
|
|
ドメインの再構成 |
必須のノード・マネージャ構成用のオラクル社推奨デフォルト値を上書きするために使用されるブール・フラグ。このオプションは、ノード・マネージャのアップグレード・タイプが |
|
ドメインの作成 |
既存のWebLogicドメインを上書き可能にするかどうかを指定するブール値。このオプションのデフォルトは |
|
ドメインの作成 |
新規作成したWebLogicドメインでサーバーを起動するときに使用するモード。この値は、 |
|
ドメインのアップグレード |
拡張テンプレートを追加せずにWebLogicドメインを更新できるようにするかどうかを指定するブール値。このオプションのデフォルトは |
|
ドメインのアップグレード |
競合があった場合に、WebLogicドメインの元の構成の要素を保持するか、拡張テンプレートの対応する要素で置き換えるかを指定するブール値。このオプションのデフォルトは |
|
ドメインの作成とドメインのアップグレード |
アプリケーションに別のディレクトリが必要な場合に、テンプレートの指定に従って使用されるアプリケーション・ディレクトリ。このオプションのデフォルトは、 |
|
ドメインの作成とドメインのアップグレード |
AppDeploymentsのサブデプロイメントのターゲットをWLSTが自動的に調整するかどうかを指定するブール値。このオプションのデフォルトは |
|
ドメインの作成とドメインのアップグレード |
クラスタまたは複数の管理対象サーバーを作成するときに、自動デプロイメントをアクティブにするかどうかを指定するブール値。このオプションのデフォルトは |
例
次の例では、AutoDeploy
オプションをfalse
に設定します。
wls:/offline> setOption('AutoDeploy', 'false')
showChanges
コマンド・カテゴリ: 編集コマンド
WLSTでの使用: オンライン
説明
現在の編集セッション中に現在のユーザーが行った構成の変更内容を表示します。エラーが発生した場合は、WLSTException
が返されます。
構文
showChanges([onlyInMemory])
引数 | 定義 |
---|---|
onlyInMemory |
オプション。まだ保存されていない変更のみを表示するかどうかを指定するブール値。この引数のデフォルトは |
例
次の例では、現在の編集セッションが開始されてから、現在のユーザーが構成に加えたすべての変更が表示されます。
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 |
オプション。編集セッションを排他的なセッションにするかどうかを指定します。 |
例
次の例は、ロック待機タイムアウトが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 |
オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値は |
例
次の例では、現在の編集セッションを停止します。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のタイプ。この値は、次のいずれかの値に設定できます。
|
sourceName |
割当てを解除するアプリケーションまたはリソースの名前。複数の名前をカンマで区切って指定することも、ワイルドカード(*)を使って指定されたタイプのすべてのリソースを指定することも可能です。 サブデプロイメントは |
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 |
オプション。ディスクに保存された編集内容も含めて、アクティブ化されていないすべての変更を元に戻すかどうかを指定するブール値。この引数のデフォルトは |
defaultAnswer |
オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値は |
例
次の例では、最後の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>
情報コマンド
表2-8 WLST構成の情報コマンド
コマンド | 説明 | WLSTの使用... |
---|---|---|
指定されたMBeanにJMXリスナーを追加します。 |
オンライン |
|
既存のサーバー構成( |
オンラインまたはオフライン |
|
WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。 |
オンラインまたはオフライン |
|
WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。 |
オンラインまたはオフライン |
|
現在の組織的な階層内でMBeanと属性を検索します。 |
オンライン |
|
変更プロセスを管理している最新の |
オンライン |
|
指定されたパスを参照してMBeanを返します。 |
オンライン |
|
指定された |
オンライン |
|
指定されたMBeanインスタンスのMBeanパスを返します。 |
オンライン |
|
cmoタイプで作成または削除できるすべての子MBeanを表示します。 |
オンライン |
|
指定されたMBeanをルックアップします。 |
オンライン |
|
現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。 |
オンラインまたはオフライン |
|
現在のMBeanまたはそのMBeanの指定された属性に関する、 |
オンライン |
|
WLST出力を指定されたファイル名にリダイレクトします。 |
オンライン |
|
以前に定義したリスナーを削除します。 |
オンライン |
|
|
オンラインまたはオフライン |
|
現在定義されているすべてのリスナーを表示します。 |
オンライン |
|
WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。 |
オンラインまたはオフライン |
|
ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します。 |
オンライン |
|
WLSTコマンドの記録を停止します。 |
オンラインまたはオフライン |
|
WLST出力のファイルへのリダイレクトを停止します。 |
オンラインまたはオフライン |
|
ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。 |
オンライン |
|
指定されたサーバーのスレッド・ダンプを表示します。 |
オンラインまたはオフライン |
|
属性名と属性値、操作など、MBeanに関する情報を表示します。 |
オンライン |
|
WLST定義およびメソッド宣言をPython ( |
オンラインまたはオフライン |
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構成のみです。
configToScript
コマンドは非推奨であり、WebLogic Serverの将来のリリースで削除されます。ドメインをリモート・サーバー上に作成する場合はpack
およびunpack
を使用することを強くお薦めします。PackおよびUnpackコマンドによるテンプレートとドメインの作成のPackおよびUnpackコマンドの概要を参照してください。
configToScript
コマンドでは次のファイルが作成されます。
-
構成の再作成に必要なコマンドが格納されているWLSTスクリプト。
-
ドメイン固有の値が格納されているプロパティ・ファイル。このファイルの値を更新すると、元の構成に似た新しいドメインを作成することができます。
-
暗号化された属性を格納するユーザー構成ファイルおよび関連キー・ファイル。ユーザー構成ファイルには暗号化された情報が格納されます。キー・ファイルには、情報の暗号化と復号化に使用される秘密キーが格納されます。
生成されたスクリプトを実行すると、次の処理が行われます。
-
サーバーが現在実行中であれば、WLSTはプロパティ・ファイル内の値を使用して接続を確立し、次にスクリプト・コマンドを実行して、サーバー・リソースを作成しようとします。
-
現在実行されているサーバーがなければ、WLSTはプロパティ・ファイル内の値でサーバーを起動し、スクリプト・コマンドを実行してサーバー・リソースを作成し、サーバーを停止します。これにより、WLSTがコマンド・シェルを終了させることがあります。
エラーが発生した場合は、WLSTException
が返されます。
構文
configToScript([configPath], [pyPath], [overwrite], [propertiesFile], [createDeploymentScript])
引数 | 定義 |
---|---|
configPath |
オプション。変換する構成が格納された |
pyPath |
オプション。変換後のWLSTスクリプトを書き込むパスとファイル名。この引数のデフォルトは |
overwrite |
オプション。スクリプト・ファイルがすでに存在する場合、そのファイルを上書きするかどうかを指定するブール値。この引数のデフォルトは |
propertiesFile |
オプション。WLSTがプロパティ・ファイルを書き込むパスとディレクトリ。この引数のデフォルトは、 |
createDeploymentScript |
オプション。WLSTがデプロイメントのみを実行するスクリプトを作成するかどうかを指定するブール値。この引数のデフォルトは |
例
次の例では、構成を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 |
オプション。登録されたインスタンスのみを検索するか、または、サーバーでインスタンス化されていないものの、作成が可能な |
例
次の例では、現在の組織的な構成階層内で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 |
オプション。 |
例
次の例では、指定された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インスタンスを表します。『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列目には、リストされた項目を説明する一連のコードが表示されます。表2-9を参照してください。
-
2列目には、項目の名前が表示されます。
-
項目が属性である場合、3列目には、その属性値が表示されます。属性が暗号化されている場合、3列目には、値のかわりにアスタリスクが表示されます。(WebLogic Scripting Toolの理解の暗号化された構成値の読み書きを参照)。
-
項目が操作である場合、3列目には、次の形式でその操作の戻り値の型と入力パラメータが表示されます。
returnType
:
parameterType
(
parameterName
)
表2-9 lsコマンド出力情報
コード | 説明 |
---|---|
|
項目が子の管理オブジェクトであることを示します。 UNIXまたはWindowsのファイル・システムにおけるディレクトリと同様に、 |
|
項目が子の管理オブジェクト、または読取り可能な属性であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに読取りパーミッションが付与されていることが前提)。(Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルト・セキュリティ・ポリシーを参照してください。) |
|
項目が書込み可能な属性であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに書込みパーミッションが付与されていることが前提)。(Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルトのセキュリティ・ポリシーを参照。) |
|
項目が実行可能な操作であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに実行パーミッションが付与されていることが前提)。(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])
引数 | 定義 |
---|---|
|
オプション。指定した管理オブジェクトの属性のみ表示します(他の項目の表示は抑制されます)。 |
c |
オプション。指定した管理オブジェクトの子の管理オブジェクトのみ表示します(他の項目の表示は抑制されます)。 |
|
オプション。指定した管理オブジェクトで呼出し可能な操作のみ表示します(他の項目の表示は抑制されます)。 この引数は、WLSTオンラインにのみ適用できます。 |
|
オプション。リストする属性、操作、および子の管理オブジェクトの管理オブジェクトへのパス名。 階層の現在の場所に対して相対的なパス名を指定することも、絶対パス名を指定することも可能です。 WLSTオフラインでは、フォワード・スラッシュ( WLSTオンラインでは、任意の管理階層のMBeanの内容をリストできます(「ツリー・コマンド」を参照)。次の構文を使用して、階層のルートを指定してください。
たとえば、サーバーの実行時階層のルートを示す例を次に示します。
この引数を指定しない場合、現在の管理オブジェクトの項目がリストされます。 |
|
オプション。コマンドで値をマップとして返すかどうかを指定するブール値。この引数のデフォルトは |
|
オプション。マップで返される出力を制御します。この表の冒頭で説明した、出力をフィルタリングする この引数は、 |
|
オプション。各属性値の継承情報を含めるかどうかを指定するブール値。指定した場合は、サーバー・テンプレートから継承された属性値がわかるように、後ろに(Inherited)という接尾辞が付けられます。この引数のデフォルトは サーバー・テンプレートについては、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 |
オプション。出力を |
例
次の例では、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 |
ブール値。 |
例
次の例では、オフライン・モードの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での使用: オンライン
構文
showListeners()
例
次の例では、現在定義されているすべてのリスナーを表示します。
wls:/mydomain/serverConfig> showListeners()
startRecording
コマンド・カテゴリ: 情報コマンド
WLSTでの使用: オンラインまたはオフライン
説明
WLSTとユーザーのすべての対話を記録します。このコマンドは、再試行するコマンドの捕捉に役立ちます。
エラーが発生した場合は、WLSTException
が返されます。
WebLogic Scripting Toolの理解のJythonモジュールとしてのWLSTのインポートで説明されているように、WLSTをJythonモジュールとしてインポートしている場合はこのコマンドを使用できません。
構文
startRecording(recordFile, [recordAll])
引数 | 定義 |
---|---|
recordFile |
WLSTコマンドを記録するファイルの名前。ファイル名は、絶対パスでも、WLSTを呼び出したディレクトリを基準とする相対パスでもかまいません。 |
recordAll |
オプション。すべてのユーザー対話をファイルに捕捉するかどうかを指定するブール値。この引数のデフォルトは |
例
次の例では、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 |
オプション。タイプは、 |
returnMap |
オプション。戻り値を含むマップを返すかどうかを指定するブール値。 |
例
次の例では、管理対象サーバー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での使用: オンラインまたはオフライン
構文
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によって異なります。デフォルトのファイル名は次の形式に基づいており、
また、ファイルを作成した場所が標準出力に出力されます。 |
userKeyFile |
オプション。指定するユーザー構成ファイルに関連付けられているキー情報を格納するファイルの名前。パス名は、絶対パスでも、WLSTを起動したファイル・システムのディレクトリを基準とする相対パスでもかまいません。 この引数を指定しない場合、ファイルは、現在のJVMで決定されるホーム・ディレクトリに格納されます。ホーム・ディレクトリの場所は、WLSTが実行されているオペレーティング・システムのタイプおよびSDKによって異なります。デフォルトのファイル名は次の形式に基づいており、
また、ファイルを作成した場所が標準出力に出力されます。 |
nm |
オプション。ノード・マネージャのユーザー名およびパスワードを格納するかどうかを指定するブール値。trueに設定した場合は、ノード・マネージャのユーザー名とパスワードが格納されます。この引数のデフォルトは |
例
次の例では、デフォルトの場所に、ユーザー構成ファイルとキー・ファイルが作成および格納されます。
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 |
オプション。出力をファイルに保存するかどうかを指定するブール値。この引数のデフォルトは |
fileName |
オプション。出力が書き込まれるファイルの名前。ファイル名は絶対パスでも、WLSTを実行しているディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは |
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>
ライフサイクル・コマンド
『Oracle WebLogic Serverサーバーの起動と停止の管理』の「サーバーのライフサイクルの理解」を参照してください。
表2-10 WLST構成のライフサイクル・コマンド
コマンド | 説明 | WLSTの使用... |
---|---|---|
ドメイン・パーティションを停止し、パーティションが停止するまで待機します。 |
オンライン |
|
クラスタ内のターゲット・サーバーにサービスを移行します。 |
オンライン |
|
あるターゲットから別のターゲットにドメイン・パーティション・リソース・グループを移行します。 |
オンライン |
|
一時停止された、または |
オンライン |
|
指定された動的クラスタの実行している動的サーバーの数を減らします。 |
オンライン |
|
指定された動的クラスタの実行している動的サーバーの数を増やします。 |
オンライン |
|
実行中のサーバー・インスタンス、クラスタまたはシステム・コンポーネントを正常に停止します。 |
オンライン |
|
システム・コンポーネント・サーバー・インスタンスを再起動します。 |
オンライン |
|
ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。 |
オンライン |
|
ドメイン・パーティションを起動し、パーティションが起動するまで待機します。 |
オンライン |
|
管理サーバーを起動します。 |
オンラインまたはオフライン |
|
実行中のサーバーを一時停止します。 |
オンライン |
forceShutdownPartitionWait
コマンド・カテゴリ: ライフサイクル・コマンド
WLSTでの使用: オンライン
説明
既存のパーティションを停止し、パーティションがSHUTDOWN状態になるまで待機します。
パーティションを作成した編集セッションでこのコマンドを使用しないでください。パーティションのライフサイクルの完全な制御には、PartitionLifeCycleRuntimeMBean
コマンドを使用します。
構文
forceShutdownPartitionWait(partition, [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 |
オプション。元のサーバーを停止するかどうかを指定するブール値。この引数のデフォルトは JTAサービスを移行する場合、 |
destinationDown |
オプション。移行先のサーバーを停止するかどうかを指定するブール値。この引数のデフォルトは 移行先が実行されておらず、この引数を JMS関連サービスを実行されていないサーバー・インスタンスに移行する場合、サーバー・インスタンスは次の起動時にJMSサービスをアクティブ化します。JTAトランザクション回復サービスを実行されていないサーバー・インスタンスに移行する場合、ターゲット・サーバー・インスタンスは起動時に回復サービスを前提とします。 |
migrationType |
オプション。移行するサービスのタイプ。有効な値は次のとおりです:
この引数のデフォルトは |
例
次の例では、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])
引数 | 定義 |
---|---|
|
リソース・グループを現在実行しているVirtualTarget。 |
|
partitionVirtualTarget内の物理ターゲット(サーバーまたはクラスタ)。これは移行元の物理ターゲットです。 |
|
移行先の物理ターゲット(サーバーまたはクラスタ)。これにより、 |
|
オプション。タイム・アウト(ミリ秒単位)。デフォルトは、無期限に待機する |
例
次の例では、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がユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトは |
例
次の例では、管理対象サーバー・インスタンスを再開します。
wls:/mydomain/serverConfig> resume('managed1', block='true')
Server 'managed1' resumed successfully.
wls:/mydomain/serverConfig>
scaleDown
コマンド・カテゴリ: ライフサイクル・コマンド
WLSTでの使用: オンライン
説明
指定された動的クラスタに対する指定された数の実行している動的サーバーを正常に停止します。サーバーIDが最も大きいサーバーが最初に停止され、続いてその次に大きいIDのサーバーが停止され、指定された数のサーバーが停止されるまで続きます。オプションで、ユーザーは動的クラスタのサイズの縮小を指定できます。ノート:
updateConfiguration
オプションが有効になっている場合、scaleDown
コマンドによって、クラスタの動的クラスタ・サイズ設定を低くし、リタイアしたサーバーに関連付けられているJMS永続メッセージおよびJTAトランザクションを破棄できます。JMSまたはJTAを使用している場合、scaleDown
をupdateConfiguration
オプションを有効にして使用しないでください。『Oracle WebLogic Server JMSリソースの管理』のクラスタのターゲット指定JMSサービスを使用する場合のベスト・プラクティスに関する項を参照してください。
構文
scaleDown (clusterName, numServers, [updateConfiguration], [block], [timeoutSeconds], [type])
引数 | 定義 |
---|---|
clusterName |
動的クラスタの名前。 |
numServers |
停止するサーバーの数。 |
updateConfiguration |
オプション。 |
block |
オプション。システム・コンポーネントが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトは |
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が動的クラスタのサイズを増やすかどうかを指定するブール値。指定しない場合、この引数はデフォルトで |
block |
オプション。システム・コンポーネントが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトは |
timeoutSeconds |
オプション。操作を取り消す前に、WLSTがサーバーの起動を待機する時間(秒単位)。デフォルト値は600秒です。 |
type |
オプション。指定する場合、引数値は |
例
次の例では、起動する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
コマンドは、進行中のすべての作業の完了を待機してから、サーバー、クラスタまたはシステム・コンポーネントを停止します。
WLSTが接続しているサーバーを停止するには、引数を指定しないでshutdown
コマンドを使用します。
管理対象サーバー・インスタンスに接続されている場合、shutdown
コマンドを使用してWLSTが接続されている管理対象サーバー・インスタンスのみを停止します。管理対象サーバー・インスタンスに接続されている間は、他のサーバーを停止することはできません。
ノート:
システム・コンポーネント(たとえば、Oracle HTTP ServerまたはOracle Data Integratorシステム・コンポーネント)を停止するには、WLSTが管理サーバーに接続されている必要があります。
エラーが発生した場合は、WLSTException
が返されます。
構文
shutdown([name], [entityType], [ignoreSessions], [timeOut], [force], [block], [properties], [waitForAllSessions])
引数 | 定義 |
---|---|
name |
オプション。停止するサーバー、クラスタまたはシステム・コンポーネントの名前。この引数のデフォルトは、WLSTが接続しているサーバーになります。 |
entityType |
オプション。タイプは、 |
ignoreSessions |
オプション。停止時に、WLSTがすべてのHTTPセッションをただちに中止する必要があるか、または、HTTPセッションの完了(またはタイムアウト)を待機するかどうかを指定するブール値。この引数のデフォルトは |
timeOut |
オプション。サーバーを一時停止する前に、サーバーが進行中の作業を完了するのをWLSTが待機する時間(秒単位)。この引数のデフォルトは0秒で、タイムアウトがないことを表します。 |
force |
オプション。WLSTが、アクティブなセッションの完了を待たずに、サーバー・インスタンスまたはクラスタを停止する必要があるかどうかを指定するブール値。この引数のデフォルトは |
block |
オプション。サーバーが停止されるまでWLSTがユーザー対話をブロックする必要があるかどうかを指定するブール値。この引数のデフォルトは |
properties |
オプション。 |
waitForAllSessions |
オプション。WLSTが停止中にすべてのHTTPセッションの完了を待機する必要があるかどうかを指定するブール値。この引数のデフォルトは、WLSTが非永続HTTPセッションの完了まで待機することを示す |
例
次の例では、接続しているサーバーを停止するように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がユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトは |
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が管理サーバーに接続されている必要があります。管理対象サーバーのみの起動の場合は、ノード・マネージャとの接続のみで十分です。
「ノード・マネージャコマンド」を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
start(name, [type], [listenAddress], [port], [block], [properties])
引数 | 定義 |
---|---|
name |
起動する管理対象サーバー、クラスタまたはシステム・コンポーネントの名前。 |
type |
オプション。タイプは、 |
listenAddress |
オプション。サーバー・インスタンスのリスニング・アドレス。指定しない場合、このデフォルトは |
port |
オプション。サーバー・インスタンスのリスニング・ポート。指定しない場合、このデフォルトは |
block |
オプション。サーバーまたはクラスタが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトは |
properties |
オプション。 |
例
次の例では、ノード・マネージャに管理対象サーバー・インスタンスを起動するように指示します。リスン・アドレスは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
を使用します。
構文
startPartitionWait(partition, [initialState], [timeout])
引数 | 定義 |
---|---|
|
起動するパーティション。これは |
|
オプション。 |
|
オプション。WLSTがパーティションの起動を待機する時間(ミリ秒単位)。パーティションがタイムアウト内に起動しない場合、コマンドはタイムアウト例外を生成します。デフォルト値は60000ミリ秒(60秒)です。 |
例
次の例では、RUNNINGモードのパーティションpartition1
を起動します。wls:/mydomain/serverConfig> startPartitionWait(cmo.lookupPartition("partition1"))
startServer
コマンド・カテゴリ: ライフサイクル・コマンド
WLSTでの使用: オンラインまたはオフライン
説明
管理サーバーを起動します。エラーが発生した場合は、WLSTException
が返されます。
ノート:
startServer
を使用して、統合型のWebLogic管理サーバー(ORACLE_HOME
ディレクトリにインストールされるFusion Middleware Suite製品の管理サーバー、またはドメインの作成時にFusion Middlewareのテンプレート(JRFおよびEnterprise Manager)を選択した場合)を起動できません。
WebLogic Server以外のFusion Middleware Suite製品の管理サーバーを起動するには、次のいずれかの方法を使用します。
-
関連するWebLogicドメインのサーバー起動スクリプトを実行します。
-
ノード・マネージャを使用して、サーバーを起動します。この方法を使用する場合、
startScriptEnabled
プロパティがノード・マネージャでtrue
に設定されていることを確認します。
構文
startServer([adminServerName], [domainName], [url], [username], [password], [domainDir], [block], [timeout], [serverLog], [systemProperties], [jvmArgs] [spaceAsJvmArgsDelimiter])
引数 | 定義 |
---|---|
adminServerName |
オプション。起動する管理サーバーの名前。この引数のデフォルトは |
domainName |
オプション。管理サーバーが属しているWebLogicドメインの名前。この引数のデフォルトは |
url |
オプション。管理サーバーのURL。startServerコマンドに指定したURLによって、 |
username |
オプション。WLSTをサーバーに接続するときのユーザー名。 |
password |
オプション。WLSTをサーバーに接続するときのパスワード。 |
domainDir |
オプション。管理サーバーが起動されるドメイン・ディレクトリ。この引数のデフォルトは、WLSTの起動元ディレクトリです。 |
block |
オプション。サーバーが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。 |
timeout |
オプション。操作を取り消す前に、WLSTがサーバーの起動を待機する時間(ミリ秒単位)。デフォルト値は60000ミリ秒です。この引数は、 |
serverLog |
オプション。サーバー・ログ・ファイルの場所。この引数のデフォルトは |
systemProperties |
オプション。サーバー・プロセスに渡すシステム・プロパティ。システム・プロパティは、名前と値のペアをカンマで区切って指定します。名前と値は等号( |
jvmArgs |
オプション。サーバー・プロセスに渡すJVM引数。複数の引数をカンマで区切って指定できます。 |
spaceAsJvmArgsDelimiter |
オプション。JVM引数がスペース区切りであるかどうかを示すブール値。デフォルト値は |
例
次の例では、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セッションの完了(またはタイムアウト)を待機するかどうかを指定するブール値。この引数のデフォルトは |
timeOut |
オプション。サーバーを一時停止する前に、サーバーが進行中の作業を完了するのをWLSTが待機する時間(秒単位)。この引数のデフォルトは0秒で、タイムアウトがないことを表します。 |
force |
オプション。アクティブなセッションの完了を待たずにサーバーを一時停止するかどうかを指定するブール値。この引数のデフォルトは |
block |
オプション。サーバーが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトは |
例
次の例では、管理対象サーバー・インスタンスを一時停止します。
wls:/mydomain/serverConfig> suspend('managed1')
Server 'managed1' suspended successfully.
wls:/mydomain/serverConfig>
ノード・マネージャ・コマンド
ノート:
特に記載のないかぎり、このカテゴリのコマンドを実行するには、ノード・マネージャを実行しておく必要があります。
『Oracle WebLogic Serverノード・マネージャ管理』の「ノード・マネージャの使用」を参照してください。
表2-11 WLST構成のノード・マネージャ・コマンド
コマンド | 説明 | WLSTの使用... |
---|---|---|
ノード・マネージャ・ホームを取得します。 |
オフライン |
|
ノード・マネージャ・タイプを取得します。 |
オフライン |
|
ノード・マネージャ・アップグレード上書きデフォルト・フラグの値を取得します。 |
オフライン |
|
ノード・マネージャのアップグレードに使用されるノード・マネージャ・アップグレード・タイプを取得します。 |
オフライン |
|
ノード・マネージャのアップグレードに使用される古いノード・マネージャ・ホームを取得します。 |
オフライン |
|
WLSTがノード・マネージャに接続しているかどうかを判断します。 |
オンライン |
|
WLSTをノード・マネージャに接続してセッションを確立します。 |
オンラインまたはオフライン |
|
WLSTをノード・マネージャ・セッションから接続解除します。 |
オンラインまたはオフライン |
|
現在のコンピュータのノード・マネージャを有効にして、指定されたWebLogicドメインのサーバーを管理します。 |
オンライン |
|
接続されたノード・マネージャを使用して、名前が付いたスクリプトを実行します。 |
オンライン |
|
指定されたサーバーのためのノード・マネージャ・プロパティ・ファイル |
オンライン |
|
ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。 |
オンラインまたはオフライン |
|
ノード・マネージャ・ログを返します。 |
オンラインまたはオフライン |
|
ノード・マネージャ・インスタンスを再起動します。 |
オンライン |
|
ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。 |
オンラインまたはオフライン |
|
ノード・マネージャで起動されたサーバーのステータスを返します。 |
オンラインまたはオフライン |
|
指定されたシステム・コンポーネント・サーバー・インスタンスを再起動します。 |
オンラインまたはオフライン |
|
ノード・マネージャを使用して、現在のWebLogicドメイン内のサーバーを起動します。 |
オンラインまたはオフライン |
|
ノード・マネージャのサーバーのバージョンを返します。 |
オンラインまたはオフライン |
|
WLSTを実行している同じコンピュータ上のノード・マネージャを起動します。 |
オンラインまたはオフライン |
|
ノード・マネージャを停止します。 |
オンラインまたはオフライン |
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 |
オプション。ノード・マネージャのホスト名。この引数のデフォルトは |
port |
オプション。ノード・マネージャのポート番号。この引数のデフォルトは、ノード・マネージャ・タイプに基づいた、次の値になります。
|
domainName |
オプション。管理するWebLogicドメインの名前。この引数のデフォルトは |
domainDir |
オプション。リモート・ノードのドメインのパスまたはディレクトリこの引数のデフォルトはWLSTを起動したディレクトリです。 |
nmType |
ノード・マネージャ・タイプ。有効な値は次のとおりです:
この引数のデフォルトは |
verbose |
オプション。WLSTがノード・マネージャに冗長モードで接続するかどうかを指定するブール値。この引数のデフォルトは |
userConfigFile |
オプション。暗号化されたユーザー名とパスワードを格納するユーザー構成ファイルの名前と場所。 ユーザー構成ファイルの作成時に、 |
userKeyFile |
オプション。指定されたユーザー構成ファイルに関連付けられていて、そのファイルの復号化に使用されるキー・ファイルの名前と場所。 |
例
次の例では、デフォルトのホストおよびポート番号と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])
引数 | 定義 |
---|---|
|
オプション。リモート・ノードのドメインのパスまたはディレクトリこの引数のデフォルトはWLSTを起動したディレクトリです。 |
|
オプション。ノード・マネージャ・ホームのパス。ドメイン情報を含む |
例
次の例では、現在のマシンをノード・マネージャに登録して、ノード・マネージャ秘密ファイル(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は |
scriptProps |
オプション。環境変数としてスクリプトに指定されるプロパティ。この引数のデフォルトは |
writer |
オプション。スクリプト出力が書き込まれる |
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 |
オプション。強制停止するサーバーの名前。この引数のデフォルトは |
serverType |
オプション。強制停止するサーバーのタイプ。この引数のデフォルトは |
pluginProps |
オプション。サーバーを強制停止するために使用するプロパティ。デフォルトは |
例
次の例では、oamserver
というサーバーを強制停止します。
wls:/nm/oamdomain> nmKill('oamserver')
Killing server 'oamserver' ...
Server oamServer killed successfully.
wls:/nm/oamdomain>
nmLog
コマンド・カテゴリ: ノード・マネージャ・コマンド
WLSTでの使用: オンラインまたはオフライン
WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。
説明
ノード・マネージャ・ログを返します。
エラーが発生した場合は、WLSTException
が返されます。
構文
nmLog([writer])
引数 | 定義 |
---|---|
writer |
オプション。ログ出力を書き込む |
例
次の例では、ノード・マネージャ・ログを表示します。
wls:/nm/oamdomain> nmLog()
Successfully retrieved the Node Manager log and written.
wls:/nm/oamdomain>
nmRestart
コマンド・カテゴリ: ノード・マネージャ・コマンド
WLSTでの使用: オンライン
WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。
説明
接続されたノード・マネージャ・インスタンスを再起動します。
エラーが発生した場合は、WLSTException
が返されます。
ノート:
startNodeManager
スクリプト以外の方法でノード・マネージャが起動された場合、ノード・マネージャの再起動にnmRestart
WLSTコマンドの使用はサポートされていません。ノード・マネージャがカスタム・スクリプトから起動された場合、またはjava weblogic.NodeManager
コマンドから起動された場合、nmRestart
コマンドを使用すると、後で失敗します。
構文
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 |
オプション。サーバーの出力ログを表示するサーバーの名前。この引数のデフォルトは |
writer |
オプション。ログ出力を書き込む |
serverType |
オプション。起動するサーバーのタイプ。この引数のデフォルトは |
例
次の例では、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 |
オプション。ステータスを表示するサーバーの名前。この引数のデフォルトは |
serverType |
オプション。起動するサーバーのタイプ。この引数のデフォルトは |
例
次の例では、ノード・マネージャで起動されたoamserver
というサーバーのステータスを表示します。
wls:/nm/oamdomain> nmServerStatus('oamserver')
RUNNING
wls:/nm/oamdomain>
nmSoftRestart
コマンド・カテゴリ: ノード・マネージャ・コマンド
WLSTでの使用: オンラインまたはオフライン
説明
ノード・マネージャで起動された指定のシステム・コンポーネント・サーバー・インスタンスを再起動します。このコマンドは、現在ノード・マネージャとWLSTでサポートされているOracleシステム・コンポーネント(OHSなど)にのみ使用できます。
serverName
引数を使用してサーバー名を指定しない場合、引数はデフォルトでmyServer
に設定されます。この引数は使用しているサーバー名と一致している必要があり、一致していない場合はコマンドが失敗します。
起動する際にノード・マネージャを使用しなかったシステム・コンポーネント・サーバー・インスタンスを再起動しようとすると、エラーが表示されます。WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。
エラーが発生した場合は、WLSTException
が返されます。
構文
nmSoftRestart([serverName], serverType, [pluginProps])
引数 | 定義 |
---|---|
serverName |
オプション。再起動するシステム・コンポーネント・サーバーの名前。デフォルトは |
serverType |
必須。起動するサーバーのタイプ(OHSなど)。この引数に使用する適切な値を決定するには、該当システム・コンポーネントの管理ガイドなどのドキュメントを参照してください。 |
pluginProps |
オプション。サーバーを強制停止するために使用するプロパティ。デフォルトは |
例
次の例では、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
ファイルを作成する必要があります。
または、nmStart
props
引数を使用して、ユーザー資格証明を提供できます(ノード・マネージャの接続後)。
prps = makePropertiesObject("AdminURL=http://listen_address:listen_port;Username=username;Password=password") nmStart("managed1",props=prps)
構文
nmStart([serverName], [domainDir], [props], [writer], [serverType], [pluginProps])
引数 | 定義 |
---|---|
serverName |
オプション。起動するサーバーの名前。 |
domainDir |
オプション。起動するサーバーのドメイン・ディレクトリ。この引数のデフォルトは、WLSTの起動元ディレクトリです。 |
props |
オプション。新しいサーバーに適用するシステム・プロパティ。 |
writer |
オプション。サーバー出力が書き込まれる |
serverType |
オプション。起動するサーバーのタイプ。この引数のデフォルトは |
pluginProps |
オプション。サーバーの起動に使用するプロパティ。デフォルトは |
例
次の例では、ノード・マネージャを使用して、現在のWebLogicドメインでmanaged1
サーバーを起動します。この例では、prps
変数にシステム・プロパティ設定を格納し、props
引数を使用してコマンドに渡されます。
wls:/nm/mydomain> prps = makePropertiesObject("AdminURL=http://listen_address:listen_port
;Username=username
;Password=password
;weblogic.ListenPort=8001") wls:/nm/mydomain> nmStart("managed1",props=prps) Starting server managed1 ... Server managed1 started successfully wls:/nm/mydomain>
次の例では、ノード・マネージャを使用して、指定されたWebLogicドメインで管理サーバーを起動します。
wls:/nm/mydomain> nmStart("AdminServer")
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がノード・マネージャを冗長モードで起動するかどうかを指定するブール値。この引数のデフォルトは |
block |
オプション。NodeManagerに正常に接続するまでまたは このオプションのデフォルトは |
timeout |
オプション。WLSTによるNodeManagerへの接続を待機するミリ秒数。このオプションのデフォルトは、120000ミリ秒です。 |
jvmArgs |
オプション。サーバー・プロセスに渡すJVM引数。複数の引数をカンマで区切って指定できます。 この引数の使用方法については、次の例を参照してください。 |
nmProperties |
オプション。ノード・マネージャ・プロパティのカンマ区切りのリスト。名前と値のペアで指定します。ノード・マネージャ・プロパティの例としては、 |
nmConnectionOptions |
blockがfalseである場合はオプションで、blockがtrueである場合は必須です。nmConnectオプションのカンマ区切りのリスト。次の引数は必須です。
次の引数はオプションです。
|
例
次の例では、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>
ツリー・コマンド
表2-12 WLST構成のツリー・コマンド
このコマンドを使用します... | 次を行うには... | WLSTの使用... |
---|---|---|
サーバーに登録されているカスタムMBeanのルートに移動します。 |
オンライン |
|
ドメインの構成階層内で最後に移動したMBean、または階層のルートである |
オンライン |
|
ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します |
オンライン |
|
ドメインの実行時階層内で最後に移動したMBean、または階層のルートである |
オンライン |
|
編集構成MBean階層内で最後に移動したMBean、または階層のルートである |
オンライン |
|
カスタムMBeanのルートに移動します。 |
オンライン |
|
WLSTが現在接続しているサーバーのJNDIツリーに移動します。 |
オンライン |
|
構成MBean階層内で最後に移動したMBean、または階層のルートである |
オンライン |
|
実行時MBean階層内で最後に移動したMBean、または階層のルートである |
オンライン |
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と対話できます。
『Oracle WebLogic Server JMXによる管理可能アプリケーションの開発』の「カスタムMBeanのインストゥルメントと登録」を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
ノート:
domainCustom()
コマンドを使用して、ドメイン実行時MBeanサーバー上のカスタムMBeanに移動することもできます。「domainCustom」を参照してください。
構文
custom([objectNamePattern])
引数 | 定義 |
---|---|
ObjectNamePattern |
|
例
次の例では、管理サーバー・インスタンス上で、構成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
コマンドを使用できます。
『Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』の「WebLogic Server MBeanの理解」を参照してください。
エラーが発生した場合は、WLSTException
が返されます。
構文
domainCustom(ObjectNamePattern)
引数 | 定義 |
---|---|
ObjectNamePattern |
|
例
次の例では、管理サーバー・インスタンス上で、構成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の値を変更すると、ドメイン構成に矛盾が生じる可能性があります。
『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が管理サーバー・インスタンスに接続されている場合に使用できます。
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>
ストア管理コマンド
表2-13 ストア管理コマンド
このコマンドを使用します... | 次を行うには... | WLSTの使用... |
---|---|---|
ストアを閉じます。 |
オフライン |
|
ファイル・ストアによって占有されているスペースを圧縮およびデフラグします。 |
オフライン |
|
ストア・コンテンツを判読可能な形式でXMLファイルへダンプします。 |
オフライン |
|
開かれているストアのリストを戻します(スクリプト・アクセス用)。 |
オフライン |
|
指定したストア内の接続のリストを戻します(スクリプト・アクセス用)。 |
オフライン |
|
ストア名、開かれているストア、またはストア内の接続を一覧表示します。 |
オフライン |
|
ファイル・ストアを開きます。 |
オフライン |
|
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 |
オプション。 |
例
次の例では、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 |
オプション。 |
例
次の例では、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変数リファレンス
表2-14 WLST変数
変数 | 説明 | 例 |
---|---|---|
cmgr |
|
wls:/mydomain/edit> cmgr.getCurrentEditor() 'weblogic' |
cmo |
現在の管理オブジェクト。 WLSTでは、この変数が現在のWLSTパスに設定されます。たとえば、serverConfig階層に変更すると、 この変数は、カスタムおよびjndi以外のすべてのWLST階層で利用できます。 |
wls:/mydomain/edit> cmo.setAdministrationPort(9092) |
connected |
WLSTが実行中のサーバーに接続しているかどうかを示すブール値。WLSTは、実行中のサーバーに接続する場合、この変数を |
wls:/mydomain/serverConfig> print connected false |
domainName |
WLSTが接続しているWebLogicドメインの名前。 |
wls:/mydomain/serverConfig> print domainName mydomain |
domainRuntimeService |
|
wls:/mydomain/serverConfig> domainRuntimeService.getServerName() 'myserver' |
editService |
|
wls:/mydomain/edit> dc = editService.getDomainConfiguration() |
exitonerror |
例外が発生した場合にWLSTがスクリプトの実行を終了するかどうかを指定するブール値。この変数のデフォルトは |
wls:/mydomain/serverConfig> print exitonerror true |
idd |
WLSTに現在接続しているユーザーのアイデンティティ・ドメイン。 |
wls:/mydomain/serverConfig> print idd dbUsers |
isAdminServer |
WLSTがWebLogic管理サーバー・インスタンスに接続しているかどうかを示すブール値。WLSTは、WebLogic管理サーバーに接続している場合、この変数を |
wls:/mydomain/serverConfig> print isAdminServer true |
mbs |
階層内の現在の場所に相当する |
wls:/mydomain/serverConfig> mbs.isRegistered(ObjectName('mydomain: Name=mydomain,Type=Domain')) |
recording |
WLSTがコマンドを記録しているかどうかを示すブール値。 |
wls:/mydomain/serverConfig> print recording true |
runtimeService |
|
wls:/mydomain/serverConfig> sr=runtimeService.getServerRuntime() |
serverName |
WLSTが接続しているサーバーの名前。 |
wls:/mydomain/serverConfig> print serverName myserver |
typeService |
|
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 |