wsadmin スクリプト・ツールの使用

オプション

-c

単一のコマンドを実行するように指定します。 -c オプションの後には、コマンドが必要です。 コマンド行では複数の -c オプションを指定することができます。 これらのオプションは、 指定した順に実行されます。

-c オプションを指定して wsadmin ツールを呼び出すと、構成に対して行ったすべての変更内容が自動的に保存されます。 構成を変更しても -c オプションを使用していない場合は、AdminConfig オブジェクトの save コマンドを使用して 変更内容を保存する必要があります。 詳細については、wsadmin ツールによる構成変更の保存に関する情報を参照してください。

-Dwsadmin.script.libraries=dir1;dir2; ...

パッケージを使用する Jython スクリプトの検索パスを指定します。 dir1 および dir2 は、 Jython パッケージが含まれているライブラリーのディレクトリー検索パスを表します。

-f

実行するスクリプトを指定します。 -f オプションの後には、ファイル名が必要です。

コマンド行では、-f オプションは 1 つしか指定できません。

-f オプションを使用すると、ネストした Jython スクリプトを含むスクリプトを実行できます。 次の例では、test2 スクリプトで test1 スクリプトをインポートしています。

#test1.py

def   listServer():
       print AdminConfig.list("Server")

#test2.py

import test1
test1.listServer()

呼び出し元スクリプトを実行するには、 app_server_root/bin ディレクトリーから以下のコマンドを実行します。

wsadmin -lang jython -f  test2.py

スクリプトの実行が終わると、システムは次のサンプル・コマンド出力を返します。

server1(cells/myCell/nodes/myNode/servers/myServer|server.xml#Server_1183122130078)

-javaoption

有効な Java 標準オプションまたは Java 標準外オプションを指定します。 コマンド行では、複数の -javaoption オプションを指定できます。

wsadmin -javaoption java_option -javaoption java_option

wsadmin.sh -javaoption java_option -javaoption java_option

コマンドの長さを短くするために、コマンドを次のように入力できます。

wsadmin -javaoption "java_option java_option"

wsadmin.sh -javaoption "java_option java_option"

移行ユーザーの場合: wsadmin -javaoption "java_option java_option" 短縮コマンドは使用できません。 長い wsadmin.sh -javaoption java_option -javaoption java_option 形式を使用する必要があります。 バージョン 8 の製品では以前のバージョンと異なり、Windows オペレーティング・システムにおいて、1 つの -javaoption オプションで複数の Java オプションをサポートしません。

Windows オペレーティング・システムでは、オプションに等号 (=) またはセミコロン (;) が含まれている場合は、オプションを二重引用符 (") で囲む必要があります。以下に例を示します。

wsadmin -javaoption "-Da.b.c=3"

Windows オペレーティング・システムは、コマンド行の引数に含まれる等号 (=) またはセミコロン (;) をブランク・スペースとして扱います。 wsadmin ツールでは、ブランク・スペースを含む引数を二重引用符で囲むことが必要です。

移行ユーザーの場合: WebSphere Application Server バージョン 8.5の場合、 wsadmin.bat 内の %javaoption% および wsadmin.sh 内の $javaOption は、JAVA_EXE 引数の末尾にあります。 これにより、 CLIENTSOAP や CLIENTSAS プロパティーなどの Java システム・プロパティーを上書きすることができます。

-lang

スクリプト・ファイル、コマンド、あるいは対話式シェルの言語を指定します。 指定可能な言語は、Jacl および Jython です。 これらの言語オプションは、jacl および jython として表されます。

このオプションは、 スクリプト・ファイル名、プロファイル・スクリプト・ファイル名または com.ibm.ws.scripting.defaultLang プロパティーに基づく言語の判別をオーバーライドします。 -lang 引数にはデフォルト値はありません。 -lang 引数内に指定された言語が -f script_file_name 引数内にある判別の元となる言語と一致しない場合、wsadmin ツールはスクリプト・ファイル名に基づいて言語を判別します。

-lang 引数を指定せず、 -f script_file_name 引数を指定した場合、wsadmin ツールはターゲットの スクリプト・ファイル名に基づいて言語を決定します。 -lang 引数も -f 引数も指定しない場合、 wsadmin ツールは、-profile profile_script_name 引数が指定されていると プロファイル・スクリプト・ファイル名に基づいて言語を決定します。 コマンド行またはプロパティーでスクリプトの言語が指定されないと、 wsadmin ツールはその言語を判別できず、エラー・メッセージが生成されます。

-p

プロパティー・ファイルを指定します。 -p オプションの後には、ファイル名が必要です。

-p の後にリストされるファイルは、スクリプト・プロセスが読み取る Java プロパティー・ファイルを表します。 3 つのレベルのデフォルト・プロパティー・ファイルが、 ユーザーがコマンド行で指定されたプロパティー・ファイルより先にロードされます。

• 第 1 レベルは、インストール時のデフォルトの wsadmin.properties で、 本製品の properties ディレクトリーにあります。
• 第 2 のレベルはユーザー・デフォルトの wsadmin.properties で、ホーム・ディレクトリーにあります。
• 第 3 レベルは、環境変数が格納されるプロパティー・ファイルです。WSADMIN_PROPERTIES参照。

コマンド行では、複数の -p オプションを指定することができます。 これらのオプションは、 指定した順に起動します。

このオプションを指定して com.ibm.ws.scripting.noechoParamNo カスタム・プロパティーを使用することもできます。 このカスタム・プロパティーを使用して、トレース・ファイルや標準出力に表示しないスクリプト・パラメーターを指定します。 このカスタム・プロパティーを使用可能にするには、noecho.prop などのテキスト・ファイルを作成します。 このテキスト・ファイルでは、トレース・ファイルや標準出力に表示しない機密データ (パスワードなど) を含む wsadmin コマンド内の位置を指定します。 テキスト・ファイルには、単一の番号、またはコンマで区切られた複数のパラメーターの番号を含めることができます。 例えば、テキスト・ファイルに以下の情報が含まれる場合があります。

com.ibm.ws.scripting.noechoParamNo=3,5

このテキスト・ファイルを wsadmin コマンドで参照した場合、3 番目と 5 番目のパラメーターの値は、トレース・ファイルや標準出力に表示されません。 カスタム・プロパティーを使用するには、wsadmin コマンドを実行し、-p オプションを指定してテキスト・ファイルを渡します。 以下に例を示します。

Jacl を使用:

wsadmin -f script_file script_arguments -p text_file

Jython を使用:

wsadmin -lang jython -f script_file script_arguments -p text_file

以下に例を示します。

wsadmin -f text.py server1 dbuser dbpassword user1 userpassword -p noecho.prop

wsadmin -f c:/text.py server1 dbuser dbpassword user1 userpassword -p c:/noecho.prop

wsadmin.sh -f text.py server1 dbuser dbpassword user1 userpassword -p noecho.prop

dbpassword および userpassword は、トレース・ファイルまたは標準出力に表示されない 3 番目と 5 番目のパラメーターです。

-profile

プロファイル・スクリプトを指定します。

プロファイル・スクリプトは、他のコマンドまたはスクリプトより先に実行されます。 次のように指定すると、-cこのコマンドを呼び出す前に、プロファイル・スクリプトが実行されます。 次のように指定すると、-f次に、プロファイル・スクリプトが実行されてから、スクリプトが実行されます。 対話モードでは、プロファイル・スクリプトを使用すれば必要な標準の初期化をどれでも実行できます。 コマンド行には複数の -profile オプションを指定することが可能で、これらは指定した順に呼び出されます。

-profileName

wsadmin ツールの実行元プロファイルを指定します。 このオプションは、次のいずれかの理由が適用される場合にのみ指定してください。

• wsadmin ツールは、 app_server_root/bin ディレクトリーから実行しますが、デフォルト・プロファイルがないか、デフォルト・プロファイル以外のプロファイルで実行する必要があります。
• 現在は、あるプロファイルの bin ディレクトリーにいるが、 別のプロファイルから wsadmin ツールを実行したい場合。
  重要: z/OS オペレーティング・システム上で稼働するWebSphere Application Server は、ユーザー作成プロファイルをサポートしません。デフォルト・プロファイルのみが使用されます。

-?

構文のヘルプを表示します。

-help

構文のヘルプを表示します。

-conntype

使用する接続のタイプを指定します。

この引数はタイプを決定するストリング (例えば SOAP) と、 その接続タイプ固有のオプションとで構成されています。 可能なタイプは以下のとおりです。SOAP,RMI,JSR160RMI,IPCかつNONE接続タイプごとに、接続に関する追加属性を指定できます。

対象:SOAP接続タイプには、以下の属性を指定できます。

表 1. -conntype SOAP 接続タイプ属性の説明 。 この属性を使用して SOAP 接続タイプを指定します。

attribute	説明
[-ホスト host_name]	接続に使用するホスト名を指定します。 デフォルトはローカル・ホストです。
[-ポート port_number]	接続に使用するポート番号を指定します。
[-user ユーザー ID]	接続の確立に使用するユーザー ID を指定します。
[-password パスワード]	接続の確立に使用するパスワードを指定します。

対象:RMI接続タイプには、以下の属性を指定できます。

表 2. -conntype RMI 接続タイプ属性の説明 。 この属性を使用して RMI 接続タイプを指定します。

attribute	説明
[-ホスト host_name]	接続に使用するホスト名を指定します。 デフォルトはローカル・ホストです。
[-ポート port_number]	接続に使用するポート番号を指定します。
[-user ユーザー ID]	接続の確立に使用するユーザー ID を指定します。
[-password パスワード]	接続の確立に使用するパスワードを指定します。

対象:JSR160RMI接続タイプには、以下の属性を指定できます。

表 3. -conntype JSR160RMI 接続タイプ属性の説明 。 この属性を使用して JSR160RMI 接続タイプを指定します。

attribute	説明
[-ホスト host_name]	接続に使用するホスト名を指定します。
[-ポート port_number]	接続に使用するポート番号を指定します。
[-user ユーザー ID]	接続の確立に使用するユーザー ID を指定します。
[-password パスワード]	接続の確立に使用するパスワードを指定します。

対象:IPC接続タイプには、以下の属性を指定できます。

表 4. -conntype IPC 接続タイプ属性の説明 。 この属性を使用して IPC 接続タイプを指定します。

attribute	説明
[-ipchost ホスト名]	接続に使用するホスト名を指定します。 この属性は、wsadmin.properties プロパティー・ファイルの com.ibm.ws.scripting.ipchost プロパティーに指定されているホスト名をオーバーライドします。
[-ポート port_number]	接続に使用するポート番号を指定します。
[-user ユーザー ID]	接続の確立に使用するユーザー ID を指定します。
[-password パスワード]	接続の確立に使用するパスワードを指定します。

Use the-conntype NONEローカル・モードで実行するオプション。 この結果、スクリプト・クライアントは稼働中のサーバーに接続されません。 アプリケーション・サーバーが稼働していなくても、 サーバー構成、アプリケーションのインストールおよびアンインストールを管理することができます。

非推奨フィーチャー: RMI コネクターのサポートは推奨されないため、最終的にはリモート・メソッド呼び出し (RMI) コネクターから JSR160RMI コネクターに切り替える必要があります。

-wsadmin_classpath

このオプションを使用すれば、追加のクラスがスクリプト処理で使用可能になります。

次のオプションをクラスパス・ストリングで使用します。

/MyDir/Myjar.jar;/yourdir/yourdir.jar

/home/MyDir/Myjar.jar;/yourdir/yourdir.jar

c:/MyDir/Myjar.jar;d:/yourdir/yourdir.jar

これにより、クラスパスがスクリプト処理のためにクラス・ローダーに追加されます。

また、wsadmin ツールによって使用されるプロパティー・ファイルにこのオプションを指定することもできます。 プロパティーは、com.ibm.ws.scripting.classpath です。 コマンド行で -wsadmin_classpath と指定すると、 このプロパティーの値は、プロパティー・ファイルで指定された値をオーバーライドします。 クラスパス・プロパティーとコマンド行オプションは、連結されません。

-host

wsadmin が接続を試行するホスト名を指定します。 各プロファイルのプロパティー・ディレクトリーにあるデフォルトの wsadmin.properties ファイルは、以下を提供します。localhostこのオプションが指定されていない場合は、ホスト・プロパティーの値として指定します。

-password

サーバーのセキュリティーが使用可能になっている場合に、コネクターがそのサーバーに接続する際に使用するパスワードを指定します。

重要: UNIX システムでは、-password オプションを使用すると、システム状況プログラムにパスワード情報が表示されるため、機密漏れが発生する可能性があります。 例えば、すべての実行中プロセスを表示するために他のユーザーが呼び出すことができる ps コマンドを使用したときに、この情報が漏れる可能性があります。 機密漏れの恐れがある場合には、このオプションは使用しないでください。 機密漏れを防止するには、以下の方法があります。

• SOAP コネクターの場合は soap.client.props ファイルに、JSR160RMI コネクターまたはリモート・メソッド呼び出し (RMI) コネクターの場合は sas.client.props ファイルに、Inter-Process Connector (IPC) コネクターの場合は ipc.client.props ファイルに、ユーザー情報およびパスワード情報を指定します。 soap.client.props、sas.client.props、および ipc.client.props ファイルは、アプリケーション・サーバー・プロファイルのプロパティー・ディレクトリーにあります。
• wsadmin ツールにおいて、プロパティー・ファイル内のログイン情報を提供する代わりに、ユーザーに対してログイン情報を求めるプロンプトが表示されるまで待機します。

-user or -username

サーバーでセキュリティーが有効になっている場合に、コネクターがサーバーに接続する際に使用するユーザー名を指定します。

-port

コネクターが使用するポートを指定します。 各アプリケーション・サーバー・プロファイルの properties ディレクトリーにあるデフォルトの wsadmin.properties ファイルでは、ポート・プロパティーでローカル・サーバーへの接続に使用する値を提供します。

-jobid

監査目的で wsadmin ツールの各呼び出しをトラッキングできるように、ジョブ ID ストリングを指定します。 ジョブ ID ストリング (jobID=xxxx) は、wsadmin ログ・ファイルの先頭に表示されます。

-tracefile

ログ出力が指示されている、ログ・ファイルの名前およびロケーションを指定します。 このオプションは wsadmin.properties ファイルの com.ibm.ws.scripting.traceFile プロパティーをオーバーライドします。

-appendtrace

トレースが、既存のログ・ファイルの終わりに追加されるのか既存のログ・ファイルをオーバーライドするのかを決定します。 指定trueトレースをログ・ファイルの末尾に追加するか、または以下を指定します。falsewsadmin 呼び出しごとにログ・ファイルをオーバーライドします。 デフォルト値は次のとおりです。false.

以下の例では、ジョブ ID オプションでログのロケーションを指定し、トレースをログ・ファイルに追加します。

wsadmin -jobid wsadmin_test_1 -tracefile /temp/wsadmin_test_1.log -appendtrace true

wsadmin -jobid wsadmin_test_1 -tracefile c:/temp/wsadmin_test_1.log -appendtrace true

wsadmin.sh -jobid wsadmin_test_1 -tracefile /temp/wsadmin_test_1.log -appendtrace true