|
|
| |
WebLogic Server コマンドライン インタフェース リファレンス
以下の節では、WebLogic Server コマンドライン インタフェースの構文を示し、各 WebLogic Server の管理、接続プールの管理、および Mbean 管理コマンドについて説明します。
コマンドライン インタフェースについて
Administration Console の代わりとして、WebLogic Server には、管理ツールやさまざまなコンフィグレーション MBean および実行時 MBean プロパティにアクセスするためのコマンドライン インタフェースが用意されています。
コマンドライン インタフェースは、以下の場合に使用します。
この章で示す例は、以下のことを前提にしています。
c:
\weblogic
ディレクトリにインストールされている
c:
\java
ディレクトリにある
WebLogic Server コマンドを実行する前に、以下のことを行っておく必要があります。
CLASSPATH
を正しく設定します。
クラスパス オプションの設定を参照してください。
この節では、WebLogic Server のコマンドを使用するための構文と必須引数を示します。WebLogic Server コマンドでは、大文字と小文字は区別されません。
構文
java weblogic.Admin [-url
URL
] [-usernameusername
]
[-passwordpassword
]COMMAND
arguments
引数
多くの WebLogic Server コマンドでは、以下の引数が必要となります。
注意: 管理クライアントがサーバに接続できない場合、すべてのコマンドの終了コードは 1 です。
管理者は、実行時 Mbean を管理するコマンドを実行するための適切なアクセス制御パーミッションを持っている必要があります。
以下の節を参照してください。
WebLogic Server 管理コマンドのリファレンス
以降の節では、WebLogic Server 管理コマンドに関する情報を提供します。
表 B-1 は、WebLogic Server 管理コマンドの概要を示しています。以降の節では、コマンドの構文と引数を説明し、各コマンドの例を紹介します。
WebLogic Server 接続プール管理コマンド リファレンスも参照してください。
タスク |
コマンド |
説明 |
---|---|---|
WebLogic Server のシャットダウンの取り消し |
URL で指定された WebLogic Server の SHUTDOWN コマンドを取り消す。 |
|
WebLogic Server への接続 |
指定した数の接続を WebLogic Server に対して行い、各接続の合計時間と平均時間をミリ秒で示す。 |
|
1 つまたは複数のコマンドのヘルプの表示 |
すべての WebLogic Server コマンドの構文と使用法に関する情報が返される(デフォルト)。HELP コマンド ラインで単一のコマンド値を指定した場合は、そのコマンドの情報が返される。 |
|
WebLogic Server ライセンスの表示 |
特定のサーバにインストールされているすべての WebLogic Server インスタンスのライセンスを表示する。 |
|
JNDI ネーミング ツリーのノードのバインドの表示 |
JNDI ネーミング ツリーのノードのバインドを示す。 |
|
WebLogic Server のロック |
特権を持たないログインに対して WebLogic Server をロックする。続けてログインが試行されると、オプションの文字列メッセージを含むセキュリティ例外が発生する。 |
|
WebLogic Server リスン ポートの検証 |
WebLogic Server ポートでリスニングを行い、WebLogic クライアント リクエストを受け付ける準備ができていることを確認するためのメッセージを送信する。 |
|
特定のサーバで生成されるログ ファイルを表示する。 |
||
WebLogic Server のシャットダウン |
URL で指定した WebLogic Server をシャットダウンする。 |
|
スレッドの表示 |
実行中の WebLogic Server スレッドのスナップショットを提供する。 |
|
WebLogic Server のロック解除 |
LOCK 操作の後で WebLogic Server のロックを解除する。 |
|
WebLogic Server のバージョンの表示 |
|
注意: 管理クライアントがサーバに接続できない場合、すべてのコマンドの終了コードは 1 です。
CANCEL_SHUTDOWN
CANCEL_SHUTDOWN コマンドは、指定した WebLogic Server に対する SHUTDOWN コマンドを取り消します。
SHUT_DOWN コマンドを使用する場合、遅延時間(秒単位)を指定できます。管理者は、この遅延時間内にシャットダウンのコマンドを取り消すことができます。SHUTDOWN コマンドによってログインは無効になり、シャットダウンを取り消した後も無効のままになることに注意してください。ログインを再び有効にするには、 UNLOCK コマンドを使用します。
java weblogic.Admin [-url
URL
] [-username
username
]
[-passwordpassword
]
CANCEL_SHUTDOWN
次の例では、ユーザ名が system
、パスワードが gumby1234
のシステム ユーザが、localhost
というマシンのポート 7001 でリスンする WebLogic Server のシャットダウンの取り消しを要求します。
java weblogic.Admin -url t3://localhost:7001 -username system
-password gumby1234 CANCEL_SHUTDOWN
指定した数の接続を WebLogic Server に対して行い、各接続の合計時間と平均時間をミリ秒で示します。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
]
CONNECTcount
引数 |
定義 |
---|---|
|
行われた接続の数。 |
次の例では、adminuser
という名前と gumby1234
というパスワードを持つユーザが CONNECT
コマンドを実行し、localhost
というサーバに 25 回の接続を確立して、これらの接続に関する情報を取得します。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 CONNECT 25
HELP
すべての WebLogic Server コマンドの構文と使用法に関する情報が返されます(デフォルト)。HELP コマンド ラインで単一のコマンド値を指定した場合は、そのコマンドの情報が返されます。
構文
java weblogic.Admin HELP [
COMMAND
]
例
次の例では、PING
コマンドの使い方に関する情報が要求されます。
java weblogic.Admin HELP PING
この場合、HELP
コマンドは、以下の情報を stdout
に返します。
Usage: weblogic.Admin [-url
url
] [-usernameusername
]
[-passwordpassword
] <COMMAND
> <ARGUMENTS
>
PING <
count
> <bytes
>
LICENSES
指定したサーバにインストールされたすべての WebLogic Server インスタンスのライセンスを示します。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
] LICENSES
次の例では、デフォルトのユーザ名(guest
)とパスワード(guest
)を使用して、localhost
というマシンのポート 7001 で動作する WebLogic Server のライセンス情報を要求します。
java weblogic.Admin -url localhost:7001 -username guest
-password guest LICENSES
LIST
JNDI ネーミング ツリーのノードのバインドを示します。
java weblogic.Admin [-username
username
] [-passwordpassword
]LIST
context
引数 |
定義 |
---|---|
|
必須。 |
この例では、ユーザ名 adminuser
、パスワード gumby1234
のユーザが weblogic.ejb
内のノード バインドのリストを要求します。
java weblogic.Admin -username
adminuser
-passwordgumby1234
LIST
weblogic.ejb
LOCK
特権を持たないログインに対して WebLogic Server をロックします。続けてログインが試行されると、オプションの文字列メッセージを含むセキュリティ例外が発生します。
注意: これは、WebLogic Server 管理ユーザのパスワードを必要とする特権付きコマンドです。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
]LOCK
"string_message
"
引数 |
定義 |
---|---|
|
省略可能。WebLogic Server がロックされているときに特権のないユーザがログインを試みると送出されるセキュリティ例外に付加するメッセージ。二重引用符で囲む。 |
次の例では、WebLogic Server がロックされます。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234LOCK
"Sorry, WebLogic Server is temporarily out of service."
権限のないユーザ名とパスワードでログインするアプリケーションに対しては、「Sorry, WebLogic Server is temporarily out of service
」というメッセージが表示されます。
PING
WebLogic Server ポートでリスニングを行い、WebLogic クライアント リクエストを受け付ける準備ができていることを確認するためのメッセージを送信します。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
] PING [round_trips
] [message_length
]
引数 |
定義 |
---|---|
|
省略可能。ping の数。 |
|
省略可能。各 ping で送信されるパケットのサイズ。ping で送信されるパケットが 10 MB を超えると、例外が発生する。 |
次の例では、localhost
というマシンのポート 7001 で動作する WebLogic Server を 10 回チェックします。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 PING 10
特定のサーバで生成されるサーバ ログ ファイルを表示します。
starttime
と endtime
を省略すると、サーバ ログ全体の表示が開始されます。
java.weblogic.Admin
[-urlURL
] [-username
username
]
[-passwordpassword
]
SERVERLOG
[[
starttime
]|[
endtime
]]
次の例では、localhost
というマシンのポート 7001 でリスンする WebLogic Server のログの表示が要求されます。
java weblogic.Admin -url
localhost:7001
SERVERLOG "2001/12/01 14:00" "2001/12/01 16:00"
この要求では、ログの表示が 2001 年 12 月 1 日の午後 2 時に始まり、2001 年 12 月 1 日の午後 4 時に終わるよう指定されます。
SHUTDOWN
URL で指定した WebLogic Server をシャットダウンします。
java weblogic.Admin [-url
URL
] [-username
username
]
[-passwordpassword
]
SHUTDOWN[
seconds
] ["
lockMessage
"]
引数 |
定義 |
---|---|
|
省略可能。このコマンドの実行時からサーバのシャットダウンまでの経過秒数。 |
|
省略可能。WebLogic Server がロックされているときにログインを試みると送出されるメッセージ。二重引用符で囲む。 |
次の例のコマンドでは、ユーザ名 adminuser
、管理パスワード gumby1234
で、localhost
というマシンのポート 7001 をリスンする WebLogic Server をシャットダウンします。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 SHUTDOWN300 "Server localhost is shutting down."
コマンドの発行後 5 分(300 秒)経過すると、指定したサーバがシャットダウンされ、次のメッセージが stdout
に送られます。
Server localhost is shutting down.
実行中の WebLogic Server スレッドのスナップショットを提供します。
構文
java weblogic.Admin [-url
URL
] [-username
username
]
[-passwordpassword
]
THREAD_DUMP
UNLOCK
LOCK 操作の後で WebLogic Server のロックを解除します。
java weblogic.Admin [-url
URL
] [-username
username
]
[-passwordpassword
]
UNLOCK
引数 |
定義 |
---|---|
|
必須。このコマンドを使用するには、適切な管理ユーザ名を指定する必要がある。 |
|
必須。このコマンドを使用するには、適切な管理パスワードを指定する必要がある。 |
次の例では、ユーザ名が adminuser
、パスワードが gumby1234
の管理者が、localhost
というマシンのポート 7001 でリスンする WebLogic Server のロックの解除を要求します。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 UNLOCK
VERSION
URL
の値で指定したマシンで動作する WebLogic Server ソフトウェアのバージョンを示します。
java weblogic.Admin -url
URL
-usernameusername
-passwordpassword
VERSION
次の例では、あるユーザが localhost
というマシンのポート 7001 で動作する WebLogic Server のバージョンを要求します。
java weblogic.Admin -url localhost:7001 -username
guest
-passwordguest
VERSION
注意: この例では、引数 username
と password
の両方にデフォルト値の guest
が使用されています。
WebLogic Server 接続プール管理コマンド リファレンス
表 B-2 は、接続プール用の WebLogic Server 管理コマンドの概要を示しています。以降の節では、コマンドの構文と引数を説明し、各コマンドの例を紹介します。
接続プールの詳細については、『WebLogic JDBC プログラミング ガイド』および 『管理者ガイド』の「JDBC 接続の管理」を参照してください。
WebLogic Server の動作中に接続プールを作成できるようにします。詳細については、『WebLogic JDBC プログラミング ガイド』の「接続プールの動的作成」を参照してください。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
]
CREATE_POOL poolName aclName=aclX
,
props=myProps
,initialCapacity=1
,maxCapacity=1
,
capacityIncrement=1
,allowShrinking=true
,shrinkPeriodMins=15
,
driver=myDriver
,url=myURL
次の例では、名前が adminuser
、パスワードが gumby1234
のユーザが、CREATE_POOL
コマンドを実行して動的接続プールを作成します。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 CREATE_POOL myPool
java weblogic.Admin -url t3://forest:7901 -username system
-password gumby1234 CREATE_POOL dynapool6 "aclName=someAcl,
allowShrinking=true,shrinkPeriodMins=10,
url=jdbc:weblogic:oracle,driver=weblogic.jdbc.oci.Driver,
initialCapacity=2,maxCapacity=8,
props=user=SCOTT;password=tiger;server=bay816"
接続はクローズされてプールから削除され、プールに残っている接続がなくなればプールは消滅します。接続プールを破棄できるのは、「system」ユーザか、またはそのプールに関連付けられている ACL によって「admin」パーミッションが与えられたユーザだけです。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
]
DESTROY_POOLpoolName
[true
|false]
次の例では、名前が adminuser
、パスワードが gumby1234
のユーザが、DESTROY_POOL
コマンドを実行してアクティブなプール接続を一時的に凍結します。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 DESTROY_POOL myPool false
接続プールを一時的に無効にして、クライアントがそのプールから接続を取得するのを防ぐことができます。接続プールを有効または無効にできるのは、「system」ユーザか、またはそのプールに関連付けられている ACL によって「admin」パーミッションが与えられたユーザだけです。
プールを無効化する方法には、後で有効化できるようにプール内の接続を凍結する方法と、接続を破棄する方法があります。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
]
DISABLE_POOLpoolName
[true
|false]
次の例では、名前が adminuser
、パスワードが gumby1234
のユーザが、DISABLE_POOL
コマンドを実行して、後で有効化する接続を凍結します。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 DISABLE_POOL myPool false
プールを有効にした場合、使用中だった各接続の JDBC 接続状態はその接続プールが無効にされたときと同じなので、クライアントはちょうど中断したところから JDBC 操作を続行できます。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
]
ENABLE_POOL poolName
引数 |
定義 |
---|---|
|
接続プールの名前。 |
次の例では、名前が adminuser
、パスワードが gumby1234
のユーザが、ENABLE_POOL
コマンドを実行して、無効化(凍結)されている接続を再確立します。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 ENABLE_POOL myPool
指定された名前の接続プールが WebLogic Server に存在するかどうかを調べます。このメソッドを使用すると、動的接続プールがすでに作成されているかどうかを調べ、作成する動的接続プールに固有の名前を付けることができます。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
]
EXISTS_POOLpoolName
引数 |
定義 |
---|---|
|
接続プールの名前。 |
次の例では、名前が adminuser
、パスワードが gumby1234
のユーザが、EXISTS_POOL
コマンドを実行して、指定した名前のプールが存在するかどうかを確認します。
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 EXISTS_POOL myPool
このコマンドでは、登録されている接続プールの接続がリセットされます。
これは特権付きのコマンドです。このコマンドを使用するには、WebLogic Server 管理ユーザのパスワードを提示する必要があります。接続プールの名前(config.xml
ファイルのエントリ)を知っていなければなりません。
構文
java weblogic.Admin
URL
RESET_POOLpoolName system password
例
このコマンドでは、ホスト xyz.com のポート 7001 でリスンしている WebLogic Server の「eng」として登録されている接続プールが更新されます。
java weblogic.Admin t3://xyz.com:7001 RESET_POOL eng system gumby
表 B-3 は、Mbean 管理コマンドの概要を示しています。以降の節では、コマンドの構文と引数を説明し、各コマンドの例を紹介します。
CREATE
コンフィグレーション Mbean のインスタンスを作成します。成功した場合は、OK
を stdout
に返します。このコマンドは実行時 Mbean では使用できません。Mbean インスタンスは、変更が行われた場所によって config.xml
ファイルかセキュリティ レルムに保存されます。
注意: Mbean を作成すると、コンフィグレーション オブジェクトも作成されます。
Mbean 作成の詳細については、『WebLogic Server アプリケーションの開発』を参照してください。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
] CREATE -namename
-typembean_type
[-domaindomain_name
]
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
] CREATE -mbeanmbean_name
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 CREATE -mbean
"mydomain:Type=Server,Name=acctServer"
DELETE
コンフィグレーション Mbean を削除します。成功した場合は、OK
を stdout
に返します。このコマンドは実行時 Mbean では使用できません。
注意: Mbean を削除すると、コンフィグレーション オブジェクトも削除されます。
Mbean 削除の詳細については、『WebLogic Server アプリケーションの開発』を参照してください。
java weblogic.Admin [-url
URL
]
[-usernameusername
] [-passwordpassword
] DELETE {-typembean_type
|-mbeanmbean_name
}
引数 |
定義 |
---|---|
|
必須。同じタイプの複数のオブジェクトに対する属性を削除するときに使用する。 |
|
必須。Mbean の完全修飾名を次の形式で指定する。
|
java weblogic.Admin -url localhost:7001 -username adminuser
-password gumby1234 DELETE -mbean
"mydomain:Type=Server,Name=AcctServer"
実行時 Mbean の属性を表示します。同じタイプの複数のオブジェクトに対する属性のリストを要求するには、次のように属性を要求します。
指定した Mbean の名前が出力されます。-pretty
を指定すると、各属性の名前と値が 1 組ずつ改行されて表示されます。
GET コマンドでは実行時 Mbean のみを呼び出すことができます。
各属性の名前と値のペアは、中括弧で囲んで指定します。この形式では、出力の解析を簡単にすることで、スクリプトの作成を容易にしています。
Mbean の名前は次のように出力されます。
{
mbeanname
mbean_name
{property1
value
} {property2
value
} .. .} {mbeanname
mbean_name
{property1
value
} {property2
value
} . . .}
. . .
-pretty
を指定すると、各属性の名前と値が 1 組ずつ改行されて表示されます。指定した Mbean のそれぞれの名前も次のように出力されます。
mbeanname
:
mbean_name
property1:
value
property2:
value
.
.
.mbeanname
:
mbean_name
property1:
value
property2:
value
java weblogic.Admin [-url
URL
]
[-usernameusername
] [-password
password
] GET {-pretty} {-typembean_type
|-mbeanmbean_name
}
[-propertyproperty1
] [-propertyproperty2
]...
次の例では、あるユーザがポート 7001 でリスンする localhost
というサーバの Mbean 属性の表示を要求します。
java weblogic.Admin -url localhost:7001 GET -pretty -type Server
INVOKE
指定した Mbean で、指定したメソッド(引数も含む)を呼び出します。このコマンドでは実行時 Mbean のみを呼び出すことができます。このコマンドは、Mbean 属性を取得または設定しないメソッドを呼び出すために使用します。
java weblogic.Admin [-url
URL
]
[-usernameusername
] [-passwordpassword
] INVOKE {-typembean_type
|-mbeanmbean_name
} -methodmethodname
[argument
. . .]
例
次の例では、getAttributeStringValue
メソッドを使用して admin_one
という管理者 Mbean を呼び出します。
java weblogic.Admin -username system -password gumby1234 INVOKE
-mbean mydomain:Name=admin_one,Type=Administrator
-method getAttributeStringValue PhoneNumber
指定したコンフィグレーション Mbean の指定した属性値を設定します。成功した場合は、OK
を stdout
に返します。このコマンドは実行時 Mbean では使用できません。
新しい値は、その値が定義された場所によって config.xml
ファイルかセキュリティ レルムに保存されます。
java weblogic.Admin [-url
URL
]
[-usernameusername
]
[-passwordpassword
] SET {-typembean_type
|-mbeanmbean_name
}
-propertyproperty1
property1_value
[-propertyproperty2
property2_value
] . . .