ナビゲーションをスキップ

WebLogic Server コマンド リファレンス

  前 次 前/次ボタンと目次ボタンとの区切り線 目次  

weblogic.Admin コマンドライン リファレンス

weblogic.Admin ユーティリティはコマンドライン インタフェースであり、このユーティリティを使用して WebLogic Server を管理、コンフィグレーション、およびモニタできます。

Administration Console と同様に、このユーティリティも、大部分のコマンドについて管理サーバ上で管理操作を呼び出すクライアントの役割をします。管理サーバではドメイン内のすべてのサーバが一元的に管理されます (すべての管理対象サーバは管理サーバからコンフィグレーション データを取得し、管理サーバはすべての管理対象サーバの実行時データにアクセスできます)。Administration Console が管理サーバとのみ対話するのに対して、weblogic.Admin ユーティリティは管理サーバとすべてのアクティブなサーバ インスタンスに直接アクセスできます。管理サーバが停止している場合でも、weblogic.Admin ユーティリティを使用して、管理対象サーバから実行時情報を取得したり、一部の管理コマンドを呼び出したりできます。ただし、ドメインの config.xml ファイルにコンフィグレーションの変更を保存できるのは、管理サーバにアクセスしているときのみです。

管理タスクを自動化するために、シェル スクリプトから weblogic.Admin ユーティリティを呼び出すことができます。シェル スクリプトからこのユーティリティを複数回呼び出す場合には、BATCHUPDATE コマンドの使用を検討してください。このコマンドについては、「バッチ モードでのコマンドの実行」を参照してください。

以下の節では、weblogic.Admin ユーティリティの使い方について説明します。

詳細については、次を参照してください。

 


weblogic.Admin ユーティリティの環境要件

weblogic.Admin ユーティリティの環境を設定するには、次の手順に従います。

  1. インストール ガイド』の説明に従って、WebLogic Server ソフトウェアをインストールおよびコンフィグレーションします。
  2. WebLogic Server クラスを CLASSPATH 環境変数に追加し、WL_HOME\server\binPATH 環境変数に追加します。
  3. WL_HOMEserver¥bin¥setWLSenv スクリプトを使用すると、両方の変数を設定できます。「クラスパスの変更」を参照してください。

  4. 管理トラフィック用に予約されているリスン ポートを weblogic.Admin ユーティリティで使用する場合は、Administration Console オンライン ヘルプの「ドメイン全体の管理ポートの有効化」の説明に従って、ドメイン全体の管理ポートをコンフィグレーションする必要があります。
  5. ドメイン全体の管理ポートは SSL で保護されています。weblogic.Admin ユーティリティでのセキュア ポートの使用については、「SSL の引数」を参照してください。

注意 : サーバ インスタンスがデッドロックされていても、ドメイン全体の管理ポートを有効にしている場合に限り、サーバ インスタンスは weblogic.Admin コマンドに応答できます。ドメイン全体の管理ポートを有効にしていない場合は、サーバを実行している Java プロセスを強制停止することでそのサーバ インスタンスを停止するしかありません。この場合、すべてのセッション データが失われます。ドメイン全体の管理ポートの有効化については、Administration Console オンライン ヘルプの「ドメイン全体の管理ポートの有効化」を参照してください。

 


weblogic.Admin ユーティリティを呼び出すための構文

java [ SSL の引数 ]
weblogic.Admin
[ 接続の引数 ]
[ ユーザ資格の引数 ]
COMMAND-NAME command-arguments

コマンド名と引数では、大文字と小文字は区別されません。

以下の節では、構文に関する詳細な情報を示します。

注意 : weblogic.Deployer ツールおよび BEA WebLogic Scripting Tool (WLST) の双方も、SSL 引数、接続の引数、およびユーザ資格の引数を使用します。

SSL の引数

java [ -Dweblogic.security.TrustKeyStore=DemoTrust ]
[ -Dweblogic.security.JavaStandardTrustKeystorePassPhrase=password ]
[ -Dweblogic.security.CustomTrustKeyStoreFileName=filename
-Dweblogic.security.TrustKeystoreType=CustomTrust
[-Dweblogic.security.CustomTrustKeystorePassPhrase=password ]
]
[ -Dweblogic.security.SSL.hostnameVerifier=classname ]
[ -Dweblogic.security.SSL.ignoreHostnameVerification=true ]
weblogic.Admin
[ ユーザ資格の引数 ]
COMMAND-NAME command-arguments

ドメイン全体の管理ポートを有効にしている場合や、SSL で保護されている他のリスン ポートを使用して管理要求を保護する場合はweblogic.Admin. 表 1-1 の呼び出し時に SSL の引数を含める必要があります。weblogic.Admin ユーティリティの SSL の引数すべての説明を示します。

表 1-1 SSL の引数

引数

定義

-Dweblogic.security.
TrustKeyStore=
DemoTrust

weblogic.Admin で、デモ用信頼キーストア (WL_HOME\server\lib\DemoTrust.jks) の CA 証明書を信頼するようにする。

この引数は、接続先のサーバ インスタンスがデモ用の ID と証明書を使用する場合には必須。

デフォルトでは、weblogic.Admin は、Java 標準信頼キーストア (SDK_HOME\jre\lib\security\cacerts) の CA 証明書のみを信頼する。

-Dweblogic.security.
JavaStandardTrustKeysto
rePassPhrase=
password

Java 標準信頼キーストアの保護に使用されたパスワードを指定する。

Java 標準信頼キーストアがパスワードで保護されており、その CA 証明書を信頼する場合には、この引数を使用する必要がある。

デフォルトでは、Java 標準信頼キーストアはパスワードで保護されていない。

-Dweblogic.security.
CustomTrustKeyStoreFileNa
me=
filename

-Dweblogic.security.Trust
KeystoreType=CustomTrust

weblogic.Admin で、filename にあるカスタム キーストアの CA 証明書を信頼するようにする。 カスタム キーストアを信頼するには、両方の引数を使用する必要がある。

-Dweblogic.security.Custo
mTrustKeystorePassPhrase=
password

カスタム キーストアの保護に使用されたパスワードを指定する。

カスタム キーストアがパスワードで保護されている場合にのみ、この引数を使用する必要がある。

-Dweblogic.security.SSL.
hostnameVerifier=
classname

カスタム ホスト名検証クラスの名前を指定する。このクラスは weblogic.security.SSL.HostnameVerifier インタフェースを実装する必要がある。

-Dweblogic.security.SSL.
ignoreHostnameVerificat
ion=true

ホスト名検証を無効にする。

SSL を使用して管理要求を保護する : 主要手順

SSL で管理要求を保護するには、次の手順に従います。

  1. 接続先のサーバ インスタンス上で双方向 SSL が無効化されていることを確認します。
  2. 『WebLogic Security の管理』の「SSL プロトコルを使用した weblogic.Admin からの WebLogic Server への接続」を参照してください。

    デフォルトでは、SSL を有効化した場合、サーバ インスタンスは一方向 SSL をサポートします。双方向 SSL の方がセキュリティが強化されるので、双方向 SSL が有効化されている場合もあります。しかし、weblogic.Admin は双方向 SSL をサポートしていません。

  3. 信頼性のある CA 証明書が、weblogic.Admin ユーティリティがファイル システムを介してアクセスできるキーストアに格納されていることを確認します。
  4. weblogic.Admin ユーティリティを呼び出すときには、以下を指定する引数を組み込みます。

weblogic.Admin 用の信頼を指定する

weblogic.Admin ユーティリティがサーバの SSL ポートに接続する場合、信頼する認証局 (CA) を記述した一連の証明書を指定する必要があります。『WebLogic Security の管理』の「プライベート キー、デジタル証明書、信頼性のある認証局」を参照してください。

weblogic.Admin 用の信頼を指定するには、次の手順に従います。

weblogic.Admin 用のホスト名検証を指定する

ホスト名検証では、クライアントの接続先のホスト名 URL と、SSL 接続の一部としてサーバが送り返すデジタル証明書のホスト名が一致していることが確認されます。ホスト名検証は、SSL クライアントまたはクライアントとして機能している SSL サーバがリモート ホスト上のアプリケーション サーバに接続する場合に役立ちます。介在者の攻撃を防ぐのに役立ちます。『WebLogic Security の管理』の「ホスト名検証の使い方」を参照してください。

weblogic.Admin 用のホスト名検証を指定するには、次の手順に従います。

接続の引数

java [ SSL の引数 ]
weblogic.Admin
[ {-url URL} | {-adminurl URL} ]
[ ユーザ資格の引数 ]
COMMAND-NAME command-arguments

大部分の weblogic.Admin コマンドを呼び出す場合には、表 1-2 にある引数を指定して、WebLogic Server インスタンスに接続します。一部のコマンドには、接続の引数に関して特別な要件があります。特別な要件については、コマンドのドキュメントで説明されています。

表 1-2 接続の引数

引数

定義

-url [protocol://]listen-address:listen-port

コマンドを実行するサーバ インスタンスのリスン アドレスおよびリスン ポート。

ほとんどの場合で、ドメイン内のすべてのサーバを一元的に管理する管理サーバのアドレスとポートを指定する必要がある。 STARTCREATE などの一部のコマンドは、必ず管理サーバ上で実行されなければならない。管理サーバ上で実行すべきコマンドかどうかは、各コマンドのドキュメントに記されている。

管理対象サーバのリスン アドレスとポートを指定した場合、コマンドはそのサーバ インスタンスのデータのみにアクセスできる。ある管理対象サーバでコマンドを実行して、別のサーバ インスタンスのデータを参照したり、変更したりすることはできない。

MBean 関連のコマンドを使用する場合、管理 MBean にアクセスするには管理サーバのリスン アドレスとポートを指定する必要がある。ローカル コンフィグレーション MBean または実行時 MBean にアクセスするには、その MBean が存在するサーバ インスタンスを指定できる。ただし、-adminurl 引数を使用して、任意のサーバからローカル コンフィグレーション MBean または実行時 MBean を取得することもできる。 MBean の存在場所の詳細については、『WebLogic JMX Service プログラマーズ ガイド』の「WebLogic Server の管理対象リソースと MBean」を参照。

SSL で保護されていないリスン ポートを使用する場合の形式は、-url [protocol://]listen-address:port

SSL で保護されているポートを使用する場合の形式は、-url secure-protocol://listen-address:port

ドメイン全体の管理ポートが設定されている場合は、管理ポート番号を指定する必要がある (-url secure-protocol://listen-address:domain-wide-admin-port)。

protocol および secure-protocol の有効な値については、「プロトコルのサポート」を参照。

リスン アドレスおよびリスン ポートの詳細については、「-Dweblogic.ListenAddress=host」および「-Dweblogic.ListenPort= portnumber」を参照。

ドメイン全体の管理ポートの詳細については、Administration Console オンライン ヘルプの「ドメイン全体の管理ポートの有効化」を参照。

この引数のデフォルト値は t3://localhost:7001

-adminurl [protocol://]Admin-Server-listen-address:listen-port

ドメイン内の任意のサーバ インスタンスのローカル コンフィグレーション MBean または実行時 MBean を管理サーバから取得できるようにする。

MBean のタイプについては、『WebLogic JMX Service プログラマーズ ガイド』の「WebLogic Server の管理対象リソースと MBean」を参照。

MBean コマンド以外のすべてのコマンドでは、-adminurl admin-address-url admin-address は同義。

-adminurl の値には管理サーバのリスン アドレスとリスン ポートを指定しなければならない。

SSL で保護されていないポートを使用する場合の形式は、-adminurl [protocol]Admin-Server-listen-address:port

SSL で保護されているポートを使用する場合の形式は、-adminurl secure-protocol://Admin-Server-listen-address:port

ドメイン全体の管理ポートが設定されている場合は、管理ポート番号を指定する必要がある (-adminurl secure-protocol://Admin-Server-listen-address:domain-wide-admin-port)。

protocol および secure-protocol の有効な値については、「プロトコルのサポート」を参照。

この引数のデフォルト値はない。

ユーザ資格の引数

java [ SSL の引数 ]
weblogic.Admin
[ 接続の引数 ]
[ { -username username [-password password] } |
[ -userconfigfile config-file [-userkeyfile admin-key] ]
]
COMMAND-NAME command-arguments

大部分の weblogic.Admin コマンドを呼び出す場合には、表 1-3 にある引数を指定して、コマンドを呼び出すパーミッションを持つ WebLogic Server ユーザのユーザ資格を指定します。

表 1-3 ユーザ資格の引数 

引数

定義

-username username

コマンドを発行するユーザの名前。このユーザには、コマンドの対象を参照または変更するための適切なパーミッションが必要。

システム管理タスクのパーミッションについては、『WebLogic リソースのセキュリティ』の「セキュリティ ロール」を参照。

-password password

ユーザ名に関連付けられているパスワード。

-password 引数を指定しない場合、weblogic.Admin はパスワードの入力を要求する。

WL_HOME\server\binPATH 環境変数に指定されている場合、weblogic.Admin は一連の WebLogic Server ライブラリを使用してパスワードが標準出力に送出されるのを防ぐ。環境変数の設定の詳細については、「weblogic.Admin ユーティリティの環境要件」を参照。

-userconfigfile config-file

暗号化されたユーザ名およびパスワードを格納するユーザ コンフィグレーション ファイルの名前と場所を指定する。その暗号化されたユーザ名とパスワードは、指定するコマンドを呼び出すパーミッションを持っていなければならない。

-userconfigfile config-file も -username username も指定しない場合、weblogic.Admin はデフォルト パス名にあるユーザ コンフィグレーション ファイルを検索する (STOREUSERCONFIG を参照)。

-userkeyfile admin-key

指定するユーザ コンフィグレーション ファイルに関連付けられているキー ファイルの名前と場所を指定する。

ユーザ コンフィグレーション ファイルの作成時に、STOREUSERCONFIG コマンドはキー ファイルを使用してユーザ名とパスワードを暗号化する。ユーザ コンフィグレーション ファイルを暗号化するキー ファイルのみが、そのユーザ名とパスワードを復号化できる。

-userkeyfile admin-key を指定しない場合、weblogic.Admin はデフォルト パス名にあるキー ファイルを検索する (STOREUSERCONFIG を参照)。

注意 : 管理クライアントがサーバに接続できない場合や WebLogic Server インスタンスがユーザ名とパスワードを拒否する場合、すべてのコマンドの終了コードは 1 になります。

ユーザ資格を指定する

ユーザ資格を指定する最も簡単な方法は、デフォルトの場所にユーザ コンフィグレーション ファイルとキー ファイルを作成することです。それ以後は、weblogic.Admin の呼び出しでユーザ資格を含める必要がなくなります。ユーザ コンフィグレーション ファイルには、単一のキー ファイルによってのみ復号可能な暗号化されたユーザ資格が格納されます。STOREUSERCONFIG を参照してください。

たとえば、次のコマンドでは、デフォルトの場所にユーザ コンフィグレーション ファイルとキー ファイルが作成されます。

java weblogic.Admin -username weblogic -password weblogic STOREUSERCONFIG

この STOREUSERCONFIG コマンドを入力した後は、コマンドラインやスクリプトで資格を指定せずに weblogic.Admin を呼び出すことができます。次に例を示します。

java weblogic.Admin GET -pretty -type -Domain

デフォルト以外の場所にユーザ コンフィグレーション ファイルまたはキー ファイルを作成した場合には、コマンドラインやスクリプトで -userconfigfile config-file 引数および -userkeyfile admin-key 引数を含めることができます。

ユーザ コンフィグレーション ファイルとキー ファイルを作成しなかった場合には、weblogic.Admin ユーティリティの呼び出し時にコマンドラインやスクリプトで直接、-username 引数と -password 引数を使用する必要があります。これらの引数では、ユーザ名とパスワードは暗号化されません。スクリプトに値を格納すると、スクリプトに読み込みアクセスできる第三者によってユーザ資格が使用されるおそれがあります。

次のリストに、weblogic.Admin のユーザ資格の引数の優先順位を示します。

ユーザ資格を指定する例

java weblogic.Admin -username weblogic -password weblogic コマンドでは、ユーザ名 weblogic およびパスワード weblogic がコマンドラインで直接指定されます。

java weblogic.Admin コマンドでは、デフォルト パス名にあるユーザ コンフィグレーション ファイルとキー ファイルが使用されます。

デフォルト パス名をコンフィグレーションする」を参照してください。

以下のコマンドでは、ユーザ コンフィグレーション ファイル c:¥wlUser1-WebLogicConfig.properties とキー ファイル e:¥secure¥myKey が使用されます。
java -userconfigfile c:¥wlUser1-WebLogicConfig.properties
-userkeyfile e:¥secure¥myKey

プロトコルのサポート

weblogic.Admin ユーティリティの -url 引数または -adminurl 引数では、t3t3shttphttps、および iiop の各プロトコルがサポートされています。

http または https を使用してサーバ インスタンスに接続する場合は、そのインスタンスの HTTP トンネリングを有効にする必要があります。 詳細については、Administration Console オンライン ヘルプの「HTTP プロトコルのコンフィグレーション」を参照してください。

iiop を使用してサーバ インスタンスに接続する場合は、そのインスタンスの iiop プロトコルを有効にする必要があります。詳細については、Administration Console オンライン ヘルプの「IIOP プロトコルの有効化およびコンフィグレーション」を参照してください。

-url 引数を使用して非セキュア ポートを指定する場合、weblogic.Admin ユーティリティはデフォルトで t3 を使用します。たとえば、java weblogic.Admin -url localhost:7001java weblogic.Admin -url t3://localhost:7001 となります。

-url 引数または -adminurl 引数のいずれかを使用して SSL で保護されたポートを指定する場合は、t3s または https を指定する必要があります。詳細については、「SSL を使用して管理要求を保護する : 主要手順」を参照してください。

例における環境

以降の節で紹介される例の多くは、以下の特定の環境が設定されていることを前提としています。

weblogic.Admin によって返される終了コード

すべての weblogic.Admin コマンドは、コマンドが成功した場合は終了コード 0、コマンドが失敗した場合は終了コード 1 を返します。

Windows コマンド プロンプトから終了コードを参照するには、weblogic.Admin コマンドの実行後に echo %ERRORLEVEL% を入力します。bash シェルで終了コードを参照するには、echo $? と入力します。

次に例を示します。

D:¥>java weblogic.Admin -username weblogic -password weblogic GET -pretty 
-mbean "MedRec:Name=MyServer,Type=Server" -property ListenPort
---------------------------
MBeanName: "MedRec:Name=MyServer,Type=Server"
ListenPort: 7010
D:¥>echo %ERRORLEVEL%
0

weblogic.Admin は、コマンドの処理中に例外が発生した場合には System.exit(1) を呼び出して Ant およびその他の Java クライアント JVM を終了させます。このデフォルトの動作は、Ant タスクに対して -noExit を指定し (wlconfig)、weblogic.Admin バッチ処理に対して -continueOnError を指定する (BATCHUPDATE) ことでオーバーライドできます。

 


ユーザ資格を格納するためのコマンド

WebLogic Server インスタンスに接続する weblogic.Admin コマンドでは、ユーザ資格を指定する必要があります。STOREUSERCONFIG コマンドを使用して、コマンドラインで直接資格を渡したり、暗号化されていない資格をスクリプトに格納したりする代わりにユーザ資格を暗号化できるようになりました。「ユーザ資格を指定する」を参照してください。

 

フッタのナビゲーションのスキップ  ページの先頭 前 次