wsadmin スクリプトを使用する管理ジョブ・タイプ

柔軟な管理環境では、wsadmin ツールを使用して、ジョブ・マネージャーに管理ジョブをサブミットすることができます。このトピックでは、 管理ジョブ、ジョブ・パラメーター、およびコマンド構文サンプルに関する詳しい情報を提供します。

柔軟な管理環境では、構成内の複数のターゲットまたはターゲット・グループにジョブをサブミットするように管理エージェントおよびジョブ・マネージャーを構成できます。その結果、管理ジョブをサブミットして、管理対象環境全体のジョブをキューに入れることができます。 それぞれの管理ジョブには対応するジョブ・タイプがあります。 ジョブのサブミットに必要なパラメーターは、このジョブ・タイプで定義します。 AdministrativeJobs コマンド・グループ内のコマンドを使用して、管理ジョブをジョブ・マネージャーにサブミットすることができます。

管理ジョブをサブミットして、アプリケーションを管理することができます。

すべてのジョブ・タイプに共通のパラメーター

submitJob コマンドを使用して、管理ジョブをサブミットします。 ジョブの実行依頼は、以下の情報で構成されます。
必須パラメーター
各 submitJob コマンドには少なくとも jobType パラメーターが必要です。 また、ほとんどの submitJob コマンドには targetList または jobParams パラメーターも必要です。
表 1. submitJob の必須パラメーターの説明. 必須パラメーターを指定して submitJob コマンドを実行します。
パラメーター 説明 タイプ
jobType 実行するジョブのタイプを指定します。 柔軟な管理環境には、アプリケーション管理、製品保守、構成、 アプリケーション・サーバーのランタイム制御ジョブなどのさまざまなジョブ・タイプがあります。 ストリング
targetList 当該ジョブを実行する管理対象ターゲット (1 つ以上) を指定します。 ストリング
jobParams 当該ジョブを実行するために、ジョブ・タイプとターゲットのほかに構成情報も指定します。 ジョブ・パラメーターは、それぞれのジョブ・タイプに固有のものです。 ストリング
オプションの汎用パラメーター
ジョブのサブミットでは、ジョブ固有のパラメーターに加えて、以下のオプション・パラメーターを任意に組み込むことができます。
表 2. submitJob のオプションの汎用パラメーターの説明. 必須パラメーターと状況に応じたオプション・パラメーターを指定して submitJob コマンドを実行します。
パラメーター 説明 タイプ
group ジョブが実行される管理対象ターゲットのグループの名前を指定します。 ストリング
username ジョブの実行時にターゲットで使用するユーザー名を指定します。ユーザー名とパスワードが指定されていない状態で、セキュリティーが有効な場合は、ジョブ・マネージャーのユーザー ID が使用されます。 ストリング
password ジョブの実行時にターゲットで使用するユーザー名のパスワードを指定します。ユーザー名とパスワードが指定されていない状態で、セキュリティーが有効な場合は、ジョブ・マネージャーのユーザー ID が使用されます。 ストリング
privateKeyFile ジョブの実行時にターゲットで使用する完全修飾秘密鍵ファイルを指定します。 鍵ストアへの絶対パスを指定してください。 ストリング
passphrase ジョブの実行時にターゲットで使用する完全修飾パスフレーズを指定します。 鍵ストアがパスフレーズを必要としている場合は、パスフレーズを指定してください。 ストリング
useSudo ターゲット・ホスト上でのコマンド 実行に代替ユーザーを使用できるようにすることを指定します。デフォルトは sudo を 使用しないことです。sudo オプションは、AIX、HP-UX、Linux、および Solaris オペレーティング・システム でのみサポートされます。

ジョブが実行する前に、ユーザーを変更できるよう useSudo を使用可能にし、 その後で必要に応じて代替ユーザーのユーザー名とパスワードを 指定してください。sudo は、「代替ユーザーが実行する (substitute user do)」ことを意味します。 ターゲット・ホストでパスワードが必要とされない場合は、これらのパスワード・フィールドはブランクのままにします。 以下の選択の組み合わせが有効です。

  • useSudo を使用可能にし、sudoUsername および sudoPassword の 値は指定しない。このように選択した場合、/etc/sudoers ファイル 内に設定されたデフォルト・ユーザーが使用され、接続ユーザーのパスワードが使用されます。
  • useSudo を使用可能にし、sudoUsername の値を指定して、 sudoPassword の値は指定しない。このように選択した場合、指定されたユーザーが使用され、 接続ユーザーのパスワードが使用されます。
  • useSudo を使用可能にし、sudoUsername の値を指定し、 sudoPassword の値を指定する。このように選択した場合、指定されたユーザーおよび sudo パスワード が使用されます。
ブール
sudoUsername 代替ユーザーのユーザー名を指定します。 どのような場合に sudoUsername の値を指定するのかについては、useSudo の説明を参照してください。 ストリング
sudoPassword 代替ユーザーのパスワードを指定します。 どのような場合に sudoPassword の値を指定するのかについては、useSudo の説明を参照してください。 ストリング
description ジョブの説明を指定します。 ストリング
activationDateTime ジョブを活動化する日時を、2006-05-03T10:30:45-0000 のフォーマットで指定します。activationDateTime パラメーター値の -0000 のセクションは、RFC 822 フォーマットを表します。Z をグリニッジ標準時 (GMT) の簡略形として指定することができます (例えば、2006-05-03T10:30:45Z)。時間帯を指定していない場合、システムはジョブ・マネージャーの時間帯を使用します。 ストリング
expirationDateTime ジョブの有効期限を、2006-05-03T10:30:45-0000 のフォーマットで指定します。activationDateTime パラメーター値の -0000 のセクションは、RFC 822 フォーマットを表します。Z をグリニッジ標準時 (GMT) の簡略形として指定することができます (例えば、2006-05-03T10:30:45Z)。時間帯を指定していない場合、システムはジョブ・マネージャーの時間帯を使用します。 ストリング
executionWindow ジョブが繰り返される場合は、その間隔を指定します。 ストリング
executionWindowUnit 繰り返し間隔の計測単位を指定します。 有効な値には、HOURSDAYSWEEKSMONTHSCONNECTONCE があります。デフォルト値は HOURS です。 ストリング
E メール システムがジョブ通知を送信する宛先の E メール・アドレスを指定します。 ストリング

ジョブ・マネージャー・プロファイルの bin ディレクトリーから wsadmin コマンドを入力します。 このトピックには、Jython スクリプト言語の例が示されています。

使用例:

AdminTask.submitJob('-jobType installApplication -targetList [Target1 Target2 Target3]
 -jobParams [applicationName MyApp] -email admin@company.com ')

対話モードの使用例:

AdminTask.submitJob('-interactive')

ジョブ結果の使用例:

submitJob コマンドを実行すると、124231200726586682 のようなジョブ・トークンが戻されます。 ジョブ・トークンについては、getJobTargetStatus コマンドを実行してください。

AdminTask.getJobTargetStatus('[-jobToken 124231200726586682]')
管理ジョブが次のような結果をログに記録します。
  • NOT_ATTEMPTED 値は、システムがジョブを完了させようとしなかったことを示します。
  • DISTRIBUTED 値は、ターゲットのエージェントがジョブを受け取ったが、そのジョブが完了しなかったことを示します。
  • ASYNC_IN_PROGRESS 値は、ターゲットがこのジョブを他のジョブと並行して実行していることを示します。
  • FAILED 値は、ジョブが失敗したことを示します。
  • REJECTED 値は、ターゲットがジョブ・タイプをサポートしていないなどの理由でターゲットがこのジョブを拒否したことを示します。
  • SUCCEEDED 値は、ジョブが正常に完了したことを示します。
  • PARTIALLY_SUCCEEDED 値は、ジョブが部分的に完了したことを示します。 例えば、ターゲットが複数のサーバーを表していて、そのターゲットのいくつかのサーバーのみでジョブが正常に完了した場合には、部分的な成功になります。

ジョブ状況の結果は通常、DISTRIBUTED から ASYNC_IN_PROGRESS へ、さらに SUCCEEDED へと進行します。 結果が FAILEDREJECTED、または SUCCEEDED になるまで、getJobTargetStatus コマンドを 2 回以上実行しなければならないことがあります。

デフォルトでは、ジョブが 1 日間 (24 時間) アクティブになっています。

インベントリーを収集するジョブのサブミット

インベントリー管理ジョブでは、インベントリー・データをターゲットから収集します。このインベントリー・データには、使用可能なジョブ・タイプ、および各ターゲットの管理対象リソース (アプリケーションやサーバーなど) の状況が含まれています。

ターゲットがホストの場合、 インベントリー・データには、ホストに関する情報 (オペレーティング・システム名、 バージョン、Installation Manager、パッケージ・グループ、パッケージ、 プロファイル、およびその他のリソース) が含まれます。

インベントリー・ジョブ が Liberty・リソースを検出するようにしたい場合、 WLP_WORKING_DIR、WLP_SHARED_DIR、または WLP_ADDITIONAL_DIRS の変数 を定義する必要があります。『Liberty サーバーの変数の設定』を参照してください。

[IBM i]注: 中央管理インストール・マネージャーは、 IBM i プラットフォーム上のアプリケーション・クライアントおよびプラグインのプロファイルを検出できません。

ジョブ・パラメーター

なし。

使用例

AdminTask.submitJob('-jobType inventory -targetList [Target1 Target2 Target3]')

ターゲット状況を収集するジョブのサブミット

状況管理ジョブでは、状況データをターゲットから収集します。ターゲットごとにアプリケーションやサーバーなどの管理対象リソースでデータを最新表示したいだけである場合は、インベントリー・ジョブの代わりにこのジョブを使用します。

Liberty サーバーがターゲットである場合、このジョブは、Liberty サーバー・リソースのサーバー状況の更新のみを行います。新しいサーバー・リソースを見つけたり、削除されたサーバー・リソース を除去することはありません。新しいサーバー・リソースを検出するには、 代わりにインベントリー・ジョブをサブミットします。

ジョブ・パラメーター

なし。

使用例

AdminTask.submitJob('-jobType status -targetList [Target1 Target2 Target3]')

ファイルを管理するジョブのサブミット

ファイル管理ジョブを使用して、ファイルの収集、配布、および除去を行うことができます。 例えば、collectFile ジョブをサブミットすれば、ファイルをジョブ・マネージャーに転送することができます。 distributeFile ジョブは、ファイルをジョブ・マネージャーからそのジョブのターゲットに転送します。removeFile ジョブは、ターゲットにそれまでに配布されたファイルを除去します。

ファイル管理ジョブはリモート・ホスト・ターゲットで使用することができます。 ファイルをリモート・ホストに送信するには distributeFile を、リモート・ホストからファイルを収集するには collectFile を、リモート・ホストからファイルを削除するには removeFile を、それぞれ使用します。

collectFile

collectFile 管理ジョブは、 ターゲット・ファイルを収集して、それをジョブ・マネージャーに転送します。 ソース・ロケーションがファイルではなくディレクトリーである場合、ジョブはそのディレクトリーの内容を再帰的に圧縮し、その結果として生成された圧縮 zip ファイルを転送します。

ジョブ・パラメーター

表 3. collectFile パラメーターの説明. 少なくとも source および destination パラメーターを指定して submitJob collectFile コマンドを実行します。
パラメーター 説明 タイプ
source 対象となるファイルまたはディレクトリーのソース・ロケーションを指定します。 システムは、ファイルのロケーションがターゲットの profile_root ディレクトリーに対して相対的なものであると判断します。 ストリング
destination 宛先ロケーションを指定します。 値は、profile_root/config/temp/JobManagerName/jobToken/targetName というディレクトリーに対する相対値です。 ストリング
distributionProvider オプションで、配布プロバイダーの名前を指定します。 ストリング

使用例

collectFile ジョブの実行例を以下に示します。
AdminTask.submitJob('[-jobType collectFile -targetList [Target1]
 -jobParams [[source logs][destination targetLocationOfFile]]]')

distributeFile

distributeFile 管理ジョブは、ジョブ・マネージャーからジョブのターゲットにファイルを転送します。ファイルを使用する後続ジョブに備えて、システムはターゲットにそのファイルを保管します。installApplication および updateApplication の各管理ジョブは、ターゲット上のアプリケーション・コンテンツの場所として、distributeFile ジョブに指定する宛先を参照します。また、このジョブを使用して、スクリプト・ファイル、およびプロパティーに基づく構成ファイルを配布することができます。

ジョブ・マネージャーから配布するファイルは、まず、ジョブ・マネージャー・プロファイルの /config/temp/JobManager ディレクトリーに入れる必要があります。 そうすると、システムはそのファイルを、管理エージェント・プロファイルまたはデプロイメント・マネージャー・プロファイルの downloadedContent ディレクトリーに移動します。 destination パラメーターは、downloadedContent ディレクトリーに対する相対値で、ファイル名または相対パス名とすることができます。 相対パスを使用して downloadedContent ディレクトリーの下に別々のサブディレクトリーを作成して、ダウンロードしたファイルを編成することができます。

トラブルの回避 (Avoid trouble) トラブルの回避 (Avoid trouble): 他のジョブをサブミットする前に distributeFile ジョブをサブミットするには、 まず最初に、配布するファイルを JobManager ディレクトリーの下に置く必要があります。JobManager ディレクトリーを手動で作成するには、以下のステップを完了します。
  1. *ALLOBJ 許可および *SECADM 許可を持つ管理ユーザーを使用し、 コマンド・プロンプトを使用してディレクトリー profile_root/JobManagerName/config/temp に移動します。
  2. 次のコマンドを入力します。mkdir JobManager
  3. 次のコマンドを入力します。chown -R QEJBSVR JobManager
  4. 配布するファイルを JobManager ディレクトリーにコピーします。
  5. 管理コンソールから、distributeFile ジョブをサブミットします。
gotcha

ジョブ・パラメーター

表 4. distributeFile パラメーターの説明. 少なくとも source および destination パラメーターを指定して submitJob distributeFile コマンドを実行します。
パラメーター 説明 タイプ
source 配布するコンテンツのソース・ロケーションを指定します。 ストリング
destination システムがコンテンツを保存する、ターゲット上の宛先ロケーションを指定します。 ストリング
distributionProvider オプションで、配布プロバイダーの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType distributeFile -targetList [Target1 Target2 Target3]
-jobParams [[source file:/MyApp.ear][destination MyApp.ear]]')

removeFile

removeFile 管理ジョブは、ターゲットに以前に配布されたファイルを除去します。ロケーション・パラメーターは、downloadedContent ディレクトリーに対する相対ロケーションで、ファイルの配布時に宛先パラメーターに指定したロケーションと同じロケーションにする必要があります。

ジョブ・パラメーター

表 5. removeFile パラメーターの説明. 少なくとも location パラメーターを指定して submitJob removeFile コマンドを実行します。
パラメーター 説明 タイプ
location ターゲットから除去するファイルのロケーションを指定します。distributeFile ジョブからの宛先値を使用します。 ストリング
distributionProvider オプションで、配布プロバイダーの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType removeFile -targetList [Target1 Target2 Target3] 
 -jobParams [location MyApp.ear]')

wsadmin スクリプトを実行するジョブのサブミット

ジョブ・マネージャーの管理対象ターゲットで wsadmin スクリプトを実行するジョブをサブミットすることができます。管理対象ターゲットとして使用できるのは、デプロイメント・マネージャーまたは統合されていないアプリケーション・サーバーです。管理対象ターゲットで wsadmin スクリプトを実行する前に、distributeFile ジョブを使用して、ジョブ・マネージャーから管理対象ターゲットにその wsadmin スクリプトとスクリプト・プロファイルを転送してください。ファイルの配布時に指定した宛先値を覚えておいてください。 その後、wsadmin スクリプトを実行する以下のジョブを実行してください。 scriptFileLocation パラメーターの宛先値を使用します。 プロファイル宛先値を指定した場合は、オプションとして、そのプロファイル宛先値を profileLocation パラメーターに使用します。

runWsadminScript ジョブの状況の結果は、 スクリプトの戻りコードに応じて異なります。戻りコードがゼロの場合、 ジョブには成功のマークが付けられます。戻りコードがゼロ以外の値の場合、 ジョブには失敗のマークが付けられます。

ジョブ・パラメーター

表 6. ジョブ・パラメーターの説明. 少なくとも scriptFileLocation パラメーターを指定して submitJob runWsadminScript コマンドを実行します。
パラメーター 説明 タイプ
scriptFileLocation 管理対象ターゲットで実行するスクリプト・ファイルのロケーションを指定します。この場所は、ファイルをターゲットに配布したときに指定された宛先です。 ストリング
profileLocation オプションとして、wsadmin スクリプトで実行するプロファイル・スクリプトのロケーションを指定します。 このパラメーターは、wsadmin の -profile パラメーターに対応しています。この場所は、ファイルをターゲットに配布する際に指定される宛先です。 ストリング
scriptParameters オプションとして、wsadmin スクリプトに渡すパラメーターを指定します。 ストリング

使用例

AdminTask.submitJob('[-jobType runWsadminScript -targetList [DmgrManagedNodeName]
 -jobParams [ [scriptFileLocation myScript.py] [profileLocation scriptProfile.py] [scriptParameters [param1 param2]] ]]')

複数のキーワードと値の対をコマンド・パラメーター (argv[] コマンド・パラメーターなど) として処理する wsadmin スクリプトの場合は、 scriptParameters を使用してそれらのキーワードと値を指定します。

AdminTask.submitJob('[-jobType runWsadminScript -targetList [myNode01]
 -jobParams [ [scriptFileLocation myScript.py] [scriptParameters [-keyword1 value1 -keyword2 value2]] ]]')

アプリケーションを管理するジョブのサブミット

アプリケーション管理ジョブを使用して、アプリケーション・サーバー上のアプリケーションを、配布、インストール、更新、除去、および制御することができます。 例えば、distributeFile、installApplication、および startApplication ジョブをサブミットして、ご使用の環境にアプリケーションをデプロイすることができます。 ご使用の環境からアプリケーションを除去するには、stopApplication、uninstallApplication、および removeFile ジョブをサブミットします。 以下のアプリケーション管理ジョブは、アプリケーション構成の管理に使用します。

installApplication

installApplication 管理ジョブは、アプリケーションまたはアプリケーション・エレメントをターゲットの環境にインストールおよびバインドします。アプリケーションをインストールする前に、distributeFile ジョブを実行して、デプロイ可能なコンテンツをターゲットに配布する必要があります。

installApplication ジョブでは、バインディング情報や 他のデプロイメント属性を指定する方法が提供されていません。その機能が必要な場合は、runWsadminScript、または configureProperties ジョブを使用できます。

重要: このジョブをサブミットする前に、デプロイメント・マネージャーまたは管理エージェントのために profile_root/downloadedContent ディレクトリーが存在していなければなりません。 このディレクトリーがまだ存在しない場合は、作成する必要があります。

ジョブ・パラメーター

表 7. installApplication パラメーターの説明. 少なくとも applicationName パラメーターを指定して submitJob installApplication コマンドを実行します。
パラメーター 説明 タイプ
applicationName インストールするアプリケーションの識別に使用するアプリケーション名を指定します。多くの場合、これはエンタープライズ・アプリケーションの基本ファイル名ですが (例えば、MyApp.ear の場合は MyApp)、任意の名前を選択することができます。 ストリング
appLocation オプションで、インストールするアプリケーション・ファイルのロケーションを指定します。デフォルトでは、 installApplication ジョブはアプリケーション名に .ear ファイル・フォーマット表記を追加し、 デフォルトの宛先ロケーションでそのアプリケーションを検索します。

したがって、applicationName として MyApp を指定すると、デフォルトではアプリケーションが管理対象ターゲットの downloadedContent/MyApp.ear となります。appLocation の値を指定する場合は、アプリケーションの配布時に指定した宛先値を使用します。

ストリング
serverName オプションで、システムがアプリケーションをインストールするサーバーの名前を指定します。 ストリング
nodeName オプションで、対象ノードを指定します。これにより、WebSphere Application Server Network Deployment セルのサーバーが決まります。 ストリング
clusterName オプションで、アプリケーションがインストールされるクラスターの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType installApplication -targetList [Target1 Target2 Target3]
 -jobParams [[applicationName MyApp]]')

または:

AdminTask.submitJob('-jobType installApplication -targetList [Target1 Target2 Target3]
 -jobParams [[applicationName MyApp][appLocation MyApp.ear][clusterName TestCluster]]')

startApplication

startApplication 管理ジョブは、ターゲットに以前にインストールされたアプリケーションを開始します。システムはアプリケーションの状況をアクティブまたは「実行中」に変更してアプリケーションをランタイムにロードし、アプリケーションを開いてクライアント要求を受け取ります。 これは、アプリケーション・デプロイメント・プロセスの最後のステップです。

ジョブ・パラメーター

表 8. startApplication パラメーターの説明. applicationName パラメーターを指定して submitJob startApplication コマンドを実行します。
パラメーター 説明 タイプ
applicationName 始動するアプリケーションの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType startApplication -targetList [Target1 Target2 Target3] 
 -jobParams [applicationName MyApp]')

stopApplication

stopApplication 管理ジョブは、ターゲット上のアプリケーションを停止します。システムはアプリケーション状況を停止済みに変更し、それ以降のクライアント要求は受け取りません。startApplication ジョブを使用して、アプリケーションを再始動することができます。 これは、アプリケーション除去プロセスの最初のステップです。

表 9. stopApplication パラメーターの説明. applicationName パラメーターを指定して submitJob stopApplication コマンドを実行します。
パラメーター 説明 タイプ
applicationName 停止するアプリケーションの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType stopApplication -targetList [Target1 Target2 Target3] 
 -jobParams [applicationName MyApp]')

updateApplication

updateApplication 管理ジョブは、ターゲット環境内のアプリケーションまたはアプリケーション・エレメントを更新します。 アプリケーションを更新する前に、distributeFile ジョブを実行して、デプロイ可能なコンテンツをターゲットに配布する必要があります。

重要: このジョブをサブミットする前に、デプロイメント・マネージャーまたは管理エージェントのために profile_root/downloadedContent ディレクトリーが存在していなければなりません。 このディレクトリーがまだ存在しない場合は、作成する必要があります。

ジョブ・パラメーター

表 10. updateApplication パラメーターの説明. 少なくとも applicationName パラメーターを指定して submitJob updateApplication コマンドを実行します。
パラメーター 説明 タイプ
applicationName 更新するアプリケーションの識別に使用するアプリケーション名を指定します。 多くの場合、これはエンタープライズ・アプリケーションの基本ファイル名ですが (例えば、MyApp.ear の場合は MyApp)、任意の名前を選択することができます。 ストリング
appLocation オプションで、インストールするアプリケーション・ファイルのロケーションを指定します。デフォルトでは、 updateApplication ジョブはアプリケーション名に .ear ファイル・フォーマット表記を追加し、 デフォルトの宛先ロケーションでそのアプリケーションを検索します。

したがって、applicationName として MyApp を指定すると、デフォルトではアプリケーションが管理対象ターゲットの downloadedContent/MyApp.ear となります。appLocation の値を指定する場合は、アプリケーションの配布時に指定した宛先値を使用します。

ストリング
serverName オプションで、システムがアプリケーションを更新するサーバーの名前を指定します。 ストリング
nodeName オプションで、対象ノードを指定します。これにより、WebSphere Application Server Network Deployment セルのサーバーが決まります。 ストリング
clusterName オプションで、アプリケーションが更新されるクラスターの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType updateApplication -targetList [Target1 Target2 Target3] 
 -jobParams [[applicationName MyApp]]')

または:

AdminTask.submitJob('-jobType updateApplication -targetList [Target1 Target2 Target3] 
 -jobParams [[applicationName MyApp][appLocation MyApp.ear][clusterName TestCluster]]')

uninstallApplication

uninstallApplication 管理ジョブは、ターゲットからアプリケーションをアンインストールします。

ジョブ・パラメーター

表 11. uninstallApplication パラメーターの説明. applicationName パラメーターを指定して submitJob uninstallApplication コマンドを実行します。
パラメーター 説明 タイプ
applicationName 除去するアプリケーションの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType uninstallApplication -targetList [Target1 Target2 Target3]
 -jobParams [applicationName MyApp]')

サーバーを管理するジョブのサブミット

システム管理者は、アプリケーション・サーバーの構成ジョブを使用して、リモートおよびローカル・アプリケーション・サーバーの構成を変更できます。

createApplicationServer

createApplicationServer 管理ジョブは、ターゲットの環境内にアプリケーション・サーバーを作成します。

ジョブ・パラメーター

表 12. createApplicationServer パラメーターの説明. 少なくとも serverName および nodeName パラメーターを指定して submitJob createApplicationServer コマンドを実行します。
パラメーター 説明 タイプ
serverName 作成するアプリケーション・サーバーの名前を指定します。サーバー名はターゲット・ノード上で固有でなければなりません。 ストリング
nodeName ターゲットが WebSphere Application Server Network Deployment セルの場合は、サーバーを作成する、セル内のノードを示すノード名を指定する必要があります。基本ノードのノード名を指定する必要はありません。 ストリング
templateName オプションとして、サーバー・テンプレートを指定します。 ストリング
templateLocation オプションとして、テンプレートが保管されているロケーションを指定します。 テンプレート・ロケーションを指定する必要がない場合は、デフォルトであるシステム定義ロケーションを使用してください。 ストリング
genUniquePorts オプションとして、サーバーに固有の http ポートを生成することを指定します。 デフォルトでは、製品が固有のポート番号を生成します。 ブール
[z/OS]specificShortName [z/OS]z/OS 環境の場合のみ、オプションとして、サーバーの特定ショート・ネームを指定します。 サーバーごとに固有の特定ショート・ネームを付ける必要があります。 デフォルトでは、製品が固有の特定ショート・ネームを割り当てます。 値は 8 文字以下で、すべて大文字でなければなりません。 [z/OS]ストリング
[z/OS]genericShortName [z/OS]z/OS 環境の場合のみ、オプションとして、サーバーの汎用ショート・ネームを指定します。 クラスターのすべてのメンバーが同じ汎用ショート・ネームを共有します。 個々のサーバーには固有の汎用ショート・ネームを付ける必要があります。 デフォルトでは、製品が固有の汎用ショート・ネームを割り当てます。 値は 8 文字以下で、すべて大文字でなければなりません。 [z/OS]ストリング
[z/OS]bitMode [z/OS]z/OS 環境の場合のみ、オプションとして、サーバーのビット・モードを指定します。 有効な値は、31 および 64 ビットです。 値が指定されていないと、製品がデフォルトのビット・モードを割り当てます。 [z/OS]整数

使用例

AdminTask.submitJob('-jobType createApplicationServer -targetList
 [Node1 Node2 Node3] -jobParams [serverName AppServer01]')

deleteApplicationServer

deleteApplicationServer 管理ジョブは、ターゲットの環境からアプリケーション・サーバーを除去します。

ジョブ・パラメーター

表 13. deleteApplicationServer パラメーターの説明. serverName および nodeName パラメーターを指定して submitJob deleteApplicationServer コマンドを実行します。
パラメーター 説明 タイプ
serverName 削除するアプリケーション・サーバーの名前を指定します。 ストリング
nodeName ターゲットが WebSphere Application Server Network Deployment セルの場合は、サーバーを削除する、セル内のノードを示すノード名を指定する必要があります。基本ノードのノード名を指定する必要はありません。 ストリング

使用例

AdminTask.submitJob('-jobType deleteApplicationServer -targetList 
 [Node1 Node2 Node3] -jobParams [serverName AppServer01]')

createProxyServer

createProxyServer 管理ジョブは、ジョブ・マネージャーの管理対象ターゲットであるデプロイメント・マネージャーのセル内に、プロキシー・サーバーを作成します。

ジョブ・パラメーター

表 14. createProxyServer パラメーターの説明. serverName および nodeName パラメーターを指定して submitJob createProxyServer コマンドを実行します。
パラメーター 説明 タイプ
serverName 作成するプロキシー・サーバーの名前を指定します。 ストリング
nodeName プロキシー・サーバーが置かれるノードを指定します。 ストリング

使用例

AdminTask.submitJob('[-jobType createProxyServer -jobParams [[serverName 
 testServer1][nodeName testNode1]] ]')

deleteProxyServer

deleteProxyServer は、ジョブ・マネージャーの管理対象ターゲットであるデプロイメント・マネージャーのセルから、プロキシー・サーバーを削除します。

ジョブ・パラメーター

表 15. deleteProxyServer パラメーターの説明. serverName および nodeName パラメーターを指定して submitJob deleteProxyServer コマンドを実行します。
パラメーター 説明 タイプ
serverName 削除するプロキシー・サーバーの名前を指定します。 ストリング
nodeName プロキシー・サーバーが置かれているノードを指定します。 ストリング

使用例

AdminTask.submitJob('[-jobType deleteProxyServer -jobParams [[serverName 
 testServer1][nodeName testNode1]] ]')

createCluster

createCluster 管理ジョブは、クラスターを作成します。 セル内にクラスターを作成するには、そのセルのデプロイメント・マネージャーをジョブ・マネージャーに登録する必要があります。

ジョブ・パラメーター

表 16. createCluster パラメーターの説明. 少なくとも clusterConfig.clusterName パラメーターを指定して submitJob createCluster コマンドを実行します。
パラメーター 説明 タイプ
clusterConfig.clusterName サーバー・クラスターの名前を指定します。 ストリング
clusterConfig.preferLocal オプションで、ノード有効範囲のルーティングの最適化を使用可能にします。 ストリング
clusterConfig.clusterType オプションで、サーバー・クラスターのタイプを指定します。 ストリング
[z/OS]clusterConfig.shortName [z/OS]オプションで、サーバー・クラスターのショート・ネームを指定します。 [z/OS]ストリング
replicationDomain.createDomain オプションで、新規クラスターの名前に設定された名前で複製ドメインを作成します。 ストリング
convertServer.serverNode オプションで、クラスターの最初のメンバーに変換する、既存サーバーのノードの名前を指定します。 ストリング
convertServer.serverName オプションで、クラスターの最初のメンバーに変換する、既存サーバーの名前を指定します。 ストリング
convertServer.memberWeight オプションで、新規クラスター・メンバーのウェイト値を指定します。 ストリング
convertServer.nodeGroup オプションで、すべてのクラスター・メンバー・ノードを所属させる必要のあるノード・グループの名前を指定します。 ストリング
convertServer.replicatorEntry オプションで、クラスターの複製ドメインにこのメンバーのレプリケーター・エントリーを作成するように指定します。 レプリケーター・エントリーは、HTTP セッション・データの複製に使用されます。 ストリング

使用例

AdminTask.submitJob('[-jobType createCluster -targetList [DmgrManagedNodeName] 
 -jobParams [clusterConfig.clusterName newCluster1]]')

createCluster コマンドに追加パラメーターを指定する場合は、パラメーターの -jobParams リストで [stepName.parameterName parameterValue] というフォーマットを使用してください。

AdminTask.submitJob('[-jobType createCluster -targetList [DmgrManagedNodeName] 
 -jobParams [ [clusterConfig.clusterName newCluster1] [clusterConfig.clusterType PROXY_SERVER] ]]')

deleteCluster

deleteCluster 管理ジョブは、クラスターを削除します。 セル内のクラスターを削除するには、そのセルのデプロイメント・マネージャーをジョブ・マネージャーに登録する必要があります。

ジョブ・パラメーター

表 17. deleteCluster パラメーターの説明. 少なくとも clusterName パラメーターを指定して submitJob deleteCluster コマンドを実行します。
パラメーター 説明 タイプ
clusterName 削除するサーバー・クラスターの名前を指定します。 ストリング
replicationDomain.deleteRepDomain オプションで、クラスターの削除時にクラスターの複製ドメインを削除することを示す場合に使用されます。 ストリング

使用例

AdminTask.submitJob('[-jobType deleteCluster -targetList [DmgrManagedNodeName] 
 -jobParams [ [clusterName newCluster1] [replicationDomain.deleteRepDomain true] ]]')

createClusterMember

createClusterMember 管理ジョブは、セル内のクラスターにクラスター・メンバーを作成します。 そのセルのデプロイメント・マネージャーをジョブ・マネージャーに登録する必要があります。

ジョブ・パラメーター

表 18. createClusterMember パラメーターの説明. 少なくとも clusterName、memberConfig.memberNode、および memberConfig.memberName パラメーターを指定して submitJob createClusterMember コマンドを実行します。
パラメーター 説明 タイプ
clusterName 新規クラスター・メンバーが属すサーバー・クラスターの名前を指定します。 ストリング
memberConfig.memberNode 新規クラスター・メンバーが置かれるノードの名前を指定します。 ストリング
memberConfig.memberName 新規クラスター・メンバーの名前を指定します。 ストリング
memberConfig.memberWeight オプションで、新規クラスター・メンバーのウェイトを指定します。 ストリング
memberConfig.memberUUID オプションで、新規クラスター・メンバーの universal unique identifier (UUID) を指定します。 ストリング
memberConfig.genUniquePorts オプションで、サーバーに定義された HTTP トランスポートに対する固有のポート番号を生成するように指定します。 ストリング
memberConfig.replicatorEntry オプションで、クラスターの複製ドメインにこのメンバーのレプリケーター・エントリーを作成するように指定します。 レプリケーター・エントリーは、HTTP セッション・データの複製に使用されます。 ストリング
[z/OS]memberConfig.specificShortName [z/OS]オプションで、クラスター・メンバーのショート・ネームを指定します。 [z/OS]ストリング
firstMember.templateName オプションで、新規クラスター・メンバーのモデルとして使用するアプリケーション・サーバー・テンプレートの名前を指定します。 ストリング
firstMember.templateServerNode オプションで、新規クラスター・メンバーのテンプレートとして使用する既存サーバーのノードの名前を指定します。 ストリング
firstMember.templateServerName オプションで、新規クラスター・メンバーのモデルとして使用するサーバーの名前を指定します。 ストリング
firstMember.nodeGroup オプションで、すべてのクラスター・メンバー・ノードを所属させる必要のあるノード・グループの名前を指定します。 ストリング
firstMember.coreGroup オプションで、すべてのクラスター・メンバーの所属先とする必要のあるコア・グループの名前を指定します。 ストリング

使用例

AdminTask.submitJob('[-jobType createClusterMember
 -targetList [DmgrManagedNodeName]
 -jobParams [ [memberConfig.memberName newCluster1mem1]
   [memberConfig.memberNode FederatedNode] [clusterName newCluster1] ]]')

deleteClusterMember

deleteClusterMember 管理ジョブは、セル内のクラスターからクラスター・メンバーを削除します。 そのセルのデプロイメント・マネージャーをジョブ・マネージャーに登録する必要があります。 クラスターでは、統合ノードに少なくとも 1 つのクラスター・メンバーがなければなりません。

ジョブ・パラメーター

表 19. deleteClusterMember パラメーターの説明. 少なくとも clusterName、memberNode、および memberName パラメーターを指定して submitJob deleteClusterMember コマンドを実行します。
パラメーター 説明 タイプ
clusterName 削除されるクラスター・メンバーが属すサーバー・クラスターの名前を指定します。 ストリング
memberNode クラスター・メンバーが置かれているノードの名前を指定します。 ストリング
memberName 削除されるクラスター・メンバーのサーバー名を指定します。 ストリング
replicatorEntry.deleteEntry オプションで、このクラスター・メンバーのサーバー名を持つレプリケーター・エントリーを、クラスターの複製ドメインから削除するように指定します。 ストリング

使用例

AdminTask.submitJob('[-jobType deleteClusterMember -targetList 
 [DmgrManagedNodeName] -jobParams [ [memberName newCluster1mem1]
 [memberNode FederatedNode] [clusterName newCluster1] ]]')

configureProperties

configureProperties 管理ジョブは、アプリケーション・サーバー構成にプロパティー・ファイルを適用します。このジョブは、AdminTask オブジェクトの PropertiesBasedConfiguration コマンド・グループの applyConfigProperties コマンドを使用して、ターゲットのプロパティーを構成します。

ジョブ・パラメーター

表 20. configureProperties パラメーターの説明. 少なくとも propertiesFileLocation パラメーターを指定して submitJob configureProperties コマンドを実行します。
パラメーター 説明 タイプ
propertiesFileLocation ターゲットのアプリケーション・サーバーに適用するプロパティー・ファイルのロケーションを指定します。

このパラメーターに指定されるパスは、デプロイメント・マネージャーの profile_root/downloadedContent ディレクトリーからの相対パスです。 このディレクトリーが存在しない場合は、configureProperties 管理ジョブを開始する前に作成する必要があります。

ストリング
variableMapLocation オプションで、プロパティー・ファイルに組み込む変数マップ・ファイルのロケーションを指定します。 ストリング

使用例

AdminTask.submitJob('-jobType configureProperties -targetList 
 [Target1 Target2 Target3] -jobParams [propertiesFileLocation  myProperties.props]')

サーバーのランタイムを管理するジョブのサブミット

システム管理者は、アプリケーション・サーバーのランタイム制御ジョブを使用して、 アプリケーション・サーバーを始動および停止できます。

startServer

startServer 管理ジョブは、対象のアプリケーション・サーバーを起動し、初期化します。

ジョブ・パラメーター

表 21. startServer パラメーターの説明. 少なくとも serverName パラメーターを指定して submitJob startServer コマンドを実行します。
パラメーター 説明 タイプ
serverName 始動するアプリケーション・サーバーを指定します。 ストリング
nodeName ジョブのターゲットがデプロイメント・マネージャー・ノードである場合は、 サーバーが存在する統合ノードの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType startServer -targetList [Target1 Target2 Target3] 
 -jobParams [serverName AppServer01]')

stopServer

stopServer 管理ジョブは、対象のアプリケーション・サーバーを停止します。 startServer ジョブを使用して、アプリケーション・サーバーを再始動します。

ジョブ・パラメーター

表 22. stopServer パラメーターの説明. 少なくとも serverName パラメーターを指定して submitJob stopServer コマンドを実行します。
パラメーター 説明 タイプ
serverName 停止するアプリケーション・サーバーを指定します。 ストリング
nodeName ジョブのターゲットがデプロイメント・マネージャー・ノードである場合は、 サーバーが存在する統合ノードの名前を指定します。 ストリング

使用例

AdminTask.submitJob('-jobType stopServer -targetList [Target1 Target2 Target3] 
 -jobParams [serverName AppServer01]')

startCluster

startCluster 管理ジョブは、クラスターを始動します。 セル内のクラスターを始動するには、そのセルのデプロイメント・マネージャーをジョブ・マネージャーに登録する必要があります。

ジョブ・パラメーター

表 23. startCluster パラメーターの説明. 少なくとも clusterName パラメーターを指定して submitJob startCluster コマンドを実行します。
パラメーター 説明 タイプ
clusterName 始動するクラスターの名前を指定します。 ストリング
rippleStart オプションで、クラスターを ripple 始動によって始動するかどうかを指定します。 デフォルト値は false です。 ストリング

使用例

クラスターの始動例を以下に示します。

AdminTask.submitJob('[-jobType startCluster -targetList [DmgrManagedNodeName] 
 -jobParams [clusterName newCluster1]]')

クラスターの ripple 始動の例を以下に示します。

AdminTask.submitJob('[-jobType createCluster -targetList [DmgrManagedNodeName] 
 -jobParams [ [clusterName newCluster1] [rippleStart true] ]]')

stopCluster

stopCluster 管理ジョブは、クラスターを停止します。 セル内のクラスターを停止するには、そのセルのデプロイメント・マネージャーをジョブ・マネージャーに登録する必要があります。

ジョブ・パラメーター

表 24. stopCluster パラメーターの説明. clusterName パラメーターを指定して submitJob stopCluster コマンドを実行します。
パラメーター 説明 タイプ
clusterName 停止するクラスターの名前を指定します。 ストリング

使用例

AdminTask.submitJob('[-jobType stopCluster -targetList [DmgrManagedNodeName] 
 -jobParams [clusterName newCluster1]]')

コマンドを実行するジョブのサブミット

システム管理者は、ジョブ・マネージャーの runCommand ジョブを使用して、リモート・ホストでコマンドを実行させることができます。 実行できるコマンドとしては、コマンド行ユーティリティー (app_server_root/bin ディレクトリーに含まれる startServer など)、wsadmin コマンド、およびオペレーティング・システム・コマンドがあります。

ジョブ・パラメーター

表 25. runCommand パラメーターの説明. 少なくとも command パラメーターを指定して submitJob runCommand コマンドを実行します。
パラメーター 説明 タイプ
コマンド 実行するコマンドの名前を指定します。 ストリング
workingDir リモート・ホスト上のコマンド・ファイルのロケーションを指定します。 デフォルト値はリモート・ホスト上の app_server_root ディレクトリーです。 ストリング

使用例

[Linux]
AdminTask.submitJob('-jobType runCommand -targetList Target1
 -username user1 -password ******* -jobParams [[command ./versionInfo.sh]]')
[Windows]
AdminTask.submitJob('-jobType runCommand -targetList Target1
 -username user1 -password ******* -jobParams [[command versionInfo.bat]]')
[Linux]
AdminTask.submitJob('-jobType runCommand -targetList Target1
 -username user1 -password *******
 -jobParams [[command "./java -version"][workingDir /opt/IBM/WebSphere/AppServer/java/bin]]')
[Windows]
AdminTask.submitJob('-jobType runCommand -targetList Target1
 -username user1 -password *******
 -jobParams [[command "java -version"][workingDir C:/WAS_v800/IBM/WebSphere/AppServer/java/bin]]')

プロファイルを管理するジョブのサブミット

システム管理者は、ジョブ・マネージャーの manageprofiles ジョブを使用して、WebSphere Application Server プロファイルの作成、拡張、および削除を行うことができます。 このジョブは manageprofiles 管理コマンドを実行します。

ジョブ・パラメーター

表 26. manageprofiles パラメーターの説明. 少なくとも wasHome および responseFile パラメーターを指定して submitJob manageprofiles コマンドを実行します。
パラメーター 説明 タイプ
wasHome WebSphere Application Server インストール済み環境のロケーションを指定します。 これは、リモート・ホスト上の app_server_root パスです。 ストリング
responseFile ジョブ・マネージャーにある manageprofiles 応答ファイルのロケーションを指定します。 ストリング
username ジョブの実行時にターゲットで使用するユーザー名を指定します。ユーザー名とパスワードが指定されていない状態で、セキュリティーが有効な場合は、ジョブ・マネージャーのユーザー ID が使用されます。 ストリング
password ジョブの実行時にターゲットで使用するユーザー名のパスワードを指定します。ユーザー名とパスワードが指定されていない状態で、セキュリティーが有効な場合は、ジョブ・マネージャーのユーザー ID が使用されます。 ストリング

使用例

AdminTask.submitJob('-jobType manageprofiles -targetList Target1 -username user1 -password *******
 -jobParams [[wasHome /WAS80GA][responseFile /temp/mp1.txt]]')

Installation Manager ジョブのサブミット

システム管理者は、Installation Manager ジョブを使用して、Installation Manager インスタンスのインストール、リポジトリーを使用した Installation Manager の更新、Installation Manager オファリングの管理、および WebSphere Application Server 製品のインストールを行うことができます。

サポートされる構成 サポートされる構成: IBM Installation Manager 1.4.3 またはそれ以降が必要です。sptcfg

installIM

installIM 管理ジョブ は、ジョブ・マネージャーからホストにインストール・キットを送信することによって、Installation Manager の 新規インスタンスをインストールします。

ジョブ・パラメーター

表 27. installIM パラメーターの説明. 少なくとも kitPath パラメーターを指定して submitJob installIM コマンドを実行します。
パラメーター 説明 タイプ
kitPath Installation Manager キットのロケーションを指定します。このパラメーターを指定しない場合、ジョブは最新の IM インストール・キット をデフォルトのロケーションから検出します。 ストリング
dataPath Installation Manager データのロケーションを指定します。 ストリング
installPath ターゲット・ホスト上の Installation Manager をインストールするロケーションを指定します。 同じホストにある現行のセル内に複数のインストール・ロケーションが存在する場合のみ、このパラメーターを指定します。 ストリング
skipPrereqCheck これが true に設定されると、オプションとして、Installation Manager のインストール時に前提条件の検査を行わないこと、および Installation Manager ディスク・スペースの検査を使用不可にすることを指定します。

デフォルト値は false です。true 値が指定されていない限り、前提条件とディスク・スペースの検査は行われます。

ブール
acceptLicense true に設定する必要があります。この パラメーターを指定しないと、ジョブは失敗します。 ブール

使用例

AdminTask.submitJob('-jobType installIM -targetList [Host1 Host2 Host3] 
 -jobParams [acceptLicense TRUE] [kitPath /IM/agent.installer.zip] -username user1 -password pw')

IBM Installation Manager インストール・キットのパスを指定しないと、 installIM ジョブは、ターゲット・プラットフォームに適した最新の IBM Installation Manager インストール・キット を、ジョブ・マネージャー上のインストール・キット・リポジトリーから 検索します。デフォルトでは、インストール・キット・リポジトリーは app_server_root/IMKits です。 このロケーションは、ジョブ・マネージャーから変更できます。「ジョブ」 > 「Installation Manager インストール・キット」をクリックし、「Installation Manager インストール・キットのロケーション」を別の場所に変更します。

updateIM

updateIM 管理ジョブは、ジョブ・マネージャーからインストール・キットを送るのではなく、リポジトリーを使用して既存の Installation Manager を更新します。 この updateIM コマンドを使用するためには、Installation Manager バージョン 1.4 以降が必要です。

ジョブ・パラメーター

表 28. updateIM パラメーターの説明. 少なくとも installPath パラメーターを指定して submitJob updateIM コマンドを実行します。
パラメーター 説明 タイプ
リポジトリー (repository) Installation Manager を更新するリポジトリーのロケーションを指定します。 パスとしては、ジョブ・マネージャー・コンピューター上のローカル・ファイルのパス、またはリモート・ファイルを指す URL を使用することができます。 ストリング
installPath Installation Manager インストール済み環境のロケーションを指定します。 ストリング
keyringFile 応答ファイルに指定されているオファリング・リポジトリーがログインを必要とするものである場合に、使用する鍵リング・ファイルのロケーションを指定します。 このリポジトリーがログインを必要としない場合は、このパラメーターを指定しないでください。 ストリング
keyringPassword オプションとして、鍵リング・ファイルのパスワードを指定します。 鍵リング・ファイルがパスワードを必要とするものでない場合は、このパラメーターを指定しないでください。 ストリング
acceptLicense true に設定する必要があります。この パラメーターを指定しないと、ジョブは失敗します。 ブール

使用例

AdminTask.submitJob('-jobType updateIM -targetList [Host1] 
 -jobParams [acceptLicense TRUE][ [repository /IM/repository] [installPath /IM] ]')

manageOfferings

manageOfferings 管理ジョブは、Installation Manager オファリングのインストール、更新、変更、ロールバック、およびアンインストールを行うことができます。 Installation Manager 応答ファイルおよびオプションとして鍵リング・ファイルを使用するジョブをサブミットし、リモート・リポジトリーを使用してオファリングを管理します。

トラブルの回避 (Avoid trouble) トラブルの回避 (Avoid trouble): デフォルトでは、ジョブで指定するデータのロケーションは絶対パスでなければなりません。
  • [Windows]パスはドライブ名で始める必要があります。
  • [AIX][HP-UX][IBM i][Linux][Solaris][z/OS]パスは / で始める必要があります。
この制限を除去するには、 Java プロパティー com.ibm.ws.admin.cimjm.disableDataLocationAbsolutePathCheck=true を true に設定します。gotcha

ジョブ・パラメーター

表 29. manageOfferings パラメーターの説明. 少なくとも responseFile パラメーターを指定して submitJob manageOfferings コマンドを実行します。
パラメーター 説明 タイプ
responseFile Installation Manager オファリングの更新、変更、ロールバック、またはアンインストールを行う応答ファイルのロケーションを指定します。 パスとしては、ジョブ・マネージャー・コンピューター上のローカル・ファイルのパス、またはリモート・ファイルを指す URL を使用することができます。 ストリング
IMPath Installation Manager インストール済み環境のロケーションを指定します。このパラメーターが指定されていないと、ジョブは、ターゲット・ホストでデフォルト Installation Manager のパスを検出して使用しようと試みます。 Installation Manager が見つからなかった場合や、複数の Installation Manager が見つかった場合は、ジョブは失敗します。 このような状況では、submitJob manageOfferings コマンドが Installation Manager のパスを指定する必要があります。 ストリング
keyringFile 応答ファイルに指定されているオファリング・リポジトリーがログインを必要とする場合に使用する鍵リング・ファイルのロケーションを指定します。 応答ファイルがログインを必要としない場合は、このパラメーターを指定しないでください。 ストリング
keyringPassword オプションとして、鍵リング・ファイルのパスワードを指定します。 鍵リング・ファイルがパスワードを必要とするものでない場合は、このパラメーターを指定しないでください。 ストリング

使用例

AdminTask.submitJob('-jobType manageOfferings -targetList [Host1 Host2 Host3] 
 -jobParams [responseFile /IM/agent.installer.zip] -username user1 -password pw')

findIMDataLocation

findIMDataLocation 管理ジョブは、Installation Manager データ・ロケーション を追加または検索できます。

セミコロン (;) を含んでいるパス の場合は二重引用符 (") で囲んでください。例えば、"/opt/my,path";/opt/data1 のようにします。 このジョブは、Installation Manager レジストリー内に 記録されているデータ・ロケーションを検出できます。UNIX プラットフォームでは、非管理インストール 用のデフォルトのレジストリーは userhome/etc/.ibm/registry にあります。 管理インストール用のデフォルトのレジストリー は /etc/.ibm/registry にあります。デフォルトのレジストリーに 記録されているデータ・ロケーションを追加する必要はありません。このジョブは、 以下のステップを実行します。
  • 「追加 IM データ・ロケーション」フィールドに指定されたデータ・ロケーションと、(システムの検索が true に設定されている場合) 検索中にジョブによって検出されたデータ・ロケーションを妥当性検査します
  • 将来の使用のために、有効なデータ・ロケーションを既存のデータ・ロケーション・リストに 追加します
  • 重複するデータ・ロケーションを削除します
  • インベントリー・ジョブを実行します
ジョブが完了したら、ターゲットのインベントリーが現在のものになります。

ジョブ・パラメーター

表 30. findIMDataLocation のパラメーターの説明. 少なくとも responseFile パラメーターを指定して submitJob findIMDataLocation コマンドを実行します。searchSystem パラメーターと dataLocations パラメーター の両方を同時に指定できます。
パラメーター 説明 タイプ
targetList ジョブのターゲット・システムのロケーションを指定します。 ストリング
searchSystem Installation Manager データ・ロケーションを検出するために CIM がターゲット・システム全体を検索する ことを指定します。 ストリング
dataLocations 使用可能な Installation Manager データ のロケーションを指定します。ジョブは、管理コンソールに登録された現行ターゲット・ユーザーに対して使用可能になっている Installation Manager データ・ロケーション のみをリストします。 ストリング

使用例

AdminTask.submitJob ('[-jobType findDataLocation -targetList targetList -jobParams [[searchSystem true] 
[datalocations path_to_data_locations_separated_by_semicolon]  ]]')

Liberty ジョブのサブミット

ジョブをサブミットして、Liberty リソースのインストールとアンインストール、および Liberty サーバーの開始と停止を行うことができます。 Liberty サーバーは、素早く開始できる動的アプリケーション・サーバーであり、XML 構成ファイルを編集することによって、簡単にフィーチャーを追加して管理できます。

サーバーを始動または停止するジョブを実行するには、Liberty のインストール済み環境に Java Development Kit (JDK) または Java ランタイム環境 (JRE) が必要です。 以下のいずれかのアクションを実行して、JDK または JRE のロケーション を設定してください。
  • server.env ファイル内で JAVA_HOME プロパティーを JDK または JRE のロケーションに設定します。 ジョブは JAVA_HOME プロパティーを読み取り、 それをターゲット環境に設定した後で、サーバーを開始または停止する コマンドを実行します。ただし、サーバーを手動で開始または停止する場合、Liberty サーバー・コマンドはこのプロパティーを使用しません。

    [z/OS]server.env ファイルは EBCDIC エンコードである必要があります。

  • [AIX][HP-UX][Linux][Solaris][z/OS]ユーザーの .bashrc ファイル内で JAVA_HOME プロパティー を JDK または JRE のロケーションに設定します。
  • [AIX][HP-UX][Linux][Solaris][z/OS]JDK または JRE のパス を PATH 環境変数に追加します。
  • [Windows]JAVA_HOME プロパティーをシステム環境変数として JDK または JRE の ロケーションに設定します。
  • [Windows]JDK または JRE のパスを PATH システム変数に追加します。

JAVA_HOME が server.env とユーザー環境のどちらにも指定されていない場合は、ジョブ・マネージャーはユーザー検索パスで JDK または JRE を探します。

installLibertyProfileResources

installLibertyProfileResources ジョブは、Liberty イメージ内のリソースを宛先ディレクトリー (ルート・ディレクトリーからの相対パス) に解凍します。 このジョブを実行する前に、以下の条件が満たされている必要があります。

  • ホスト・コンピューターがジョブ・マネージャーに登録されていなければなりません。
  • イメージ (圧縮された zip ファイル) に、 ジョブ・マネージャー規則を満たすディレクトリー構造で Liberty リソース が含まれていなければなりません。『Liberty リソースのパッケージ化』を参照してください。
  • リソースをインストールする ルート・ディレクトリーがターゲット・ホスト上に定義されていなければなりません。最低限、WLP_WORKING_DIR 変数 を、ターゲット・ホスト上の有効なディレクトリーに設定してください。ターゲット・ホスト上の 共有ディレクトリーにリソースをインストールするには、 WLP_SHARED_DIR 変数を有効なディレクトリーに設定する必要があります。『Liberty サーバーの変数の設定』を参照してください。

リソースのデプロイメント中に、製品によって、各 Liberty サーバー内の bootstrap.properties ファイルに変数置換が適用されます。

[z/OS]server.env ファイルは EBCDIC エンコードである必要があります。

この ジョブは、以下の方法を順に試行することによって、ターゲット・ホスト上でイメージを 解凍します。
  • ホスト上で unzip ユーティリティーを使用する。
  • ホスト上で jar ユーティリティー (インベントリー・ジョブで検出された Software Development Kit (SDK) からの jar ユーティリティー を含む) を使用する。
  • [Windows]管理者によって特に使用不可にされていない場合、このジョブの実行期間中にリモート・ホストに コピーされる unzip ユーティリティーを使用する。この unzip ユーティリティー は、ジョブが完了した後に削除されます。
  • ジョブ・マネージャー上で zip ファイルを unzip し、 宛先ホストに一度に 1 つずつファイルをコピーする。この方法は、 Liberty サーバー・イメージがジョブ・マネージャー上にある場合のみ適用されます。

リソース・インスタンスが宛先ディレクトリー内に既に存在する場合、 このジョブはリソースをインストールせずに失敗します。

ジョブ・パラメーター

表 31. installLibertyProfileResources パラメーターの説明. 少なくとも image パラメーターまたは url パラメーターを指定して submitJob installLibertyProfileResources コマンド を実行します。
パラメーター 説明 タイプ
image Liberty イメージを提供する圧縮ファイルがジョブ・マネージャー・ホスト上にある場合は、圧縮ファイルの絶対パス名を指定します。例えば、以下のようになります。
[AIX][HP-UX][Linux][Solaris]
/resources/my_liberty_server.zip
[Windows]
c:/resources/my_liberty_server.zip
ストリング
url Liberty リソースを提供する圧縮ファイルがジョブ・マネージャー・ホスト上にない場合は、圧縮ファイルの URL パスを指定します。Universal Resource Locator (URL) 用にサポートされているスキーム名 には、httphttpsftp、 および file があります。
制約事項: file 以外 の URL プロトコルを指定するには、ターゲット・ホストに wget ユーティリティーが ある必要があります。ターゲット・ホスト上の wget ユーティリティーがサポートする、httphttps、 または ftp リモート・ダウンロード・プロトコルを選択 してください。wget ユーティリティーでサポートされない プロトコルを選択すると、ジョブはリソースをインストールできません。

例えば、 リソース・ファイル my_liberty_server.zip には、以下の URL の 1 つを指定します。

Liberty サーバー・リソースが HTTP サーバーまたは HTTPS サーバーに存在する場合は、以下のようにします。

http://www.mycompany.com/resources/my_liberty_server.zip

https://www.mycompany.com/resources/my_liberty_server.zip

リソース が FTP サーバーにある場合:

ftp://www.mycompany.com/resources/my_liberty_server.zip

リソース がターゲット・ホスト・コンピューター上にある場合、URL は、file スキーム を使用して圧縮ファイルのパスと名前を記述することができます。

[AIX][HP-UX][Linux][Solaris]
file:///resources/my_liberty_server.zip
[Windows]
file://c:/resources/my_liberty_server.zip

URL がパスワード で保護されている場合、urluser および urlpassword の値も指定する必要があります。

ストリング
share Liberty リソースを共有ディレクトリーにインストールするかどうかを指定します。 true に 設定されている場合、リソースは WLP_SHARED_DIR 変数で定義 された場所にインストールされます。WLP_SHARED_DIR 変数が定義されていないか、 有効なディレクトリーを指定していない場合、エラーが戻され、 イメージ内のリソースは解凍されません。

デフォルト値である false に 設定されている場合、ジョブは WLP_WORKING_DIR 変数で定義された 場所にリソースをインストールします。

ブール
urluser URL のユーザー名を指定します。URL を指定し、その URL が パスワードで保護されている場合、ユーザー名を指定する必要があります。 それ以外の場合は、urluser の値を指定しないでください。 ストリング
urlpassword urluser が URL にアクセスするのを 可能にするパスワードを指定します。URL を指定し、その URL が パスワードで保護されている場合、パスワードを指定する必要があります。それ以外の場合は、urlpassword の値を指定しないでください。 ストリング

使用例

次の 例では、イメージはジョブ・マネージャーと同じホスト上にあり、 WLP_WORKING_DIR にインストールされます。
AdminTask.submitJob('[-jobType installLibertyProfileResources -targetList [host_name]
 -description installLibertyProfileResources
 -jobParams [ [image /tmp/liberty/wlpwithjava.zip] [share FALSE] ]]')
次の 例では、イメージはターゲット・ホスト上にあり、イメージの file URL が指定されていて、 WLP_WORKING_DIR にインストールされます。
AdminTask.submitJob('[-jobType installLibertyProfileResources -targetList [host_name]
 -description installLibertyProfileResources
 -jobParams [ [url file://c:/LibertyWorking/LibertyWorkingwjava.zip] [share FALSE] ]]')
次の 例では、イメージは、パスワード保護されたリモートの ftp サーバー上にあり、 WLP_WORKING_DIR にインストールされます。
AdminTask.submitJob('[-jobType installLibertyProfileResources -targetList [host_name]
 -description installLibertyProfileResources
 -jobParams [ [urlpassword ftp_pwd] [url ftp://www.mycompany.com/projects/liberty/image-0111003.zip]
     [share FALSE] [urluser ftp_user] ]]')
次の 例では、イメージは、パスワード保護されたリモートの http サーバー上に あり、WLP_WORKING_DIR にインストールされます。
AdminTask.submitJob('[-jobType installLibertyProfileResources -targetList [host_name]
 -description installLibertyProfileResources
 -jobParams [ [urlpassword http_pwd] [url http://www.mycompany.com/projects/liberty/image-0111003.zip]
    [share FALSE] [urluser http_user] ]]')
次の 例では、イメージは、パスワード保護されたリモートの https サーバー 上にあり、WLP_SHARED_DIR にインストールされます。
AdminTask.submitJob('[-jobType installLibertyProfileResources -targetList [host_name]
 -description installLibertyProfileResources
 -jobParams [ [urlpassword http_pwd] [url https://www.mycompany.com/projects/liberty/image-0111003.zip]
    [share TRUE] [urluser http_user] ]]')

uninstallLibertyProfileResources

uninstallLibertyProfileResources ジョブ は、ジョブ・マネージャーによる管理からリソースを削除します。削除されるリソースは、installLibertyProfileResources ジョブ によってホスト上の宛先ディレクトリーに以前にインストールされたか、 または、Liberty イメージを unzip することによる手動インストールの後でインベントリー・ジョブによって 検出されたものです。

以下のいずれかの状態が当てはまる場合は、 エラーが戻され、リソースは削除されません。
  • 削除対象として複数のリソース・タイプがコマンドに指定されている。
  • リソース名が、同名の複数のリソースに解決される。
  • ジョブ・マネージャーがアクセスして検索することのできるディレクトリーにリソースが存在していない。
トラブルの回避 (Avoid trouble) トラブルの回避 (Avoid trouble): このジョブが失敗した場合、 いくつかのファイルが削除される可能性があります。リソースが壊れた状態になる可能性があります。この問題 を修正するために手動でリソース・ファイルを変更する場合、ファイルを変更した後、 インベントリー・ジョブを実行してインベントリーを更新してください。gotcha

ジョブ・パラメーター

表 32. uninstallLibertyProfileResources パラメーターの説明. submitJob uninstallLibertyProfileResources コマンドを 実行する際には、削除するリソースを指示する 1 つのみのパラメーターを指定します。
パラメーター 説明 タイプ
projectName 削除するプロジェクトの名前またはリソース ID を 指定します。すべてのサーバーでこのプロジェクトが検索されます。特定された 稼働中の各サーバーごとに、サーバーが停止された後でリソースの削除が試行されます。 ストリング
runtimeName 削除する Liberty ランタイムの名前またはリソース ID を指定します。 すべてのサーバーでこのランタイム が検索されます。特定された 稼働中の各サーバーごとに、サーバーが停止された後でリソースの削除が試行されます。 ストリング
sdkName 削除する Software Development Kit (SDK) の 名前またはリソース ID を指定します。 ストリング
serverName 削除するサーバーの名前またはリソース ID を 指定します。サーバーが稼働中の場合、サーバーが停止された後でリソースが削除されます。 ストリング
applicationBinaryName 削除するアプリケーション・バイナリーの名前またはリソース ID を 指定します。 ストリング
forceDelete オプションで、リソースの状況を検出できなくてもリソース を削除するかどうかを指定します。デフォルトは false で、 リソースを削除しません。値を true にすると、サーバー・リソースの状況を検出できない場合、およびサーバーを停止できない場合にも、サーバー・リソースは削除されます。サーバーの状況を検出できない場合、この forceDelete オプションが指定されていなければ uninstallLibertyProfileResources ジョブ は失敗します。 ブール

使用例

次の例 では、DefaultWebApplication.war アプリケーション・バイナリー がジョブ・マネージャー管理から削除されます。

AdminTask.submitJob('[-jobType uninstallLibertyProfileResources -targetList [host_name]
 -description uninstallLibertyProfileResources
 -jobParams [ [applicationBinaryName DefaultWebApplication.war] ]]')

startLibertyProfileServer

startLibertyProfileServer ジョブは、1 つ以上の Liberty サーバー・リソースを開始します。サーバー・リソースの状況は Stopped から Started に変わります。

このジョブを実行するには、Liberty サーバーに Java Development Kit (JDK) または Java ランタイム環境 (JRE) が必要です。 以下のいずれかのアクションを実行して、JDK または JRE のロケーション を設定してください。
  • server.env ファイル内で JAVA_HOME プロパティーを JDK または JRE のロケーションに設定します。 ジョブは JAVA_HOME プロパティーを読み取り、 それをターゲット環境に設定した後で、サーバーを開始する コマンドを実行します。ただし、ユーザーがサーバーを手動で開始する場合、Liberty サーバー・コマンド はこのプロパティーを使用しません。

    [z/OS]server.env ファイルは EBCDIC エンコードである必要があります。

  • [AIX][HP-UX][Linux][Solaris][z/OS]ユーザーの .bashrc ファイル内で JAVA_HOME プロパティー を JDK または JRE のロケーションに設定します。
  • [AIX][HP-UX][Linux][Solaris][z/OS]JDK または JRE のパス を PATH 環境変数に追加します。
  • [Windows]JAVA_HOME プロパティーをシステム環境変数として JDK または JRE の ロケーションに設定します。
  • [Windows]JDK または JRE のパスを PATH システム変数に追加します。

ジョブ・パラメーター

表 33. startLibertyProfileServer パラメーターの説明. startResource パラメーターを指定して submitJob startLibertyProfileServer コマンドを実行します。
パラメーター 説明 タイプ
startResource 開始する Liberty サーバー・リソースのパス名を指定します。 ストリング

使用例

以下の例は、Liberty サーバー・リソース server1 を開始します。

AdminTask.submitJob('-jobType startLibertyProfileServer -targetList host_name
 -description startLibertyProfileServer
 -jobParams [[startResource runtime/wlp/liberty_server/server1 ]]')

stopLibertyProfileServer

stopLibertyProfileServer ジョブでは、1 つ以上の実行中の Liberty サーバー・リソースを停止します。 サーバー・リソースの状況は Started から Stopped に変わります。

このジョブを実行するには、Liberty サーバーに Java Development Kit (JDK) または Java ランタイム環境 (JRE) が必要です。 JDK または JRE のロケーション がターゲット上に設定されていることを確認してください。JDK または JRE の ロケーションの設定については、startLibertyProfileServer を参照してください。

ジョブ・パラメーター

表 34. stopLibertyProfileServer パラメーターの説明. stopResourceパラメーターを指定して submitJob stopLibertyProfileServer コマンドを実行します。
パラメーター 説明 タイプ
stopResource 停止する Liberty サーバー・リソースのパス名を指定します。 ストリング

使用例

以下の例は、Liberty サーバー・リソースを停止します。

AdminTask.submitJob('-jobType stopLibertyProfileServer -targetList host_name
 -description stopLibertyProfileServer
 -jobParams [[stopResource project/proj1/runtime/wlp/liberty_server/defaultServer]]')

generateMergedPluginConfigForLibertyProfileServers

generateMergedPluginConfigForLibertyProfileServers ジョブは、ターゲット・ホスト上の Liberty サーバー用に生成されたすべての plugin-cfg.xml ファイルをマージして、単一の plugin-cfg.xml ファイルを作成します。

このジョブには、複数のターゲット・ホスト上にある 1 つの Liberty サーバーを指定できます。Liberty サーバーが検出されると、そのサーバー上に plugin-cfg.xml ファイルが 1 つ生成されてから、そのコピーがジョブ・マネージャーに戻されます。 ターゲットにしたすべての Liberty サーバーですべての plugin-cfg.xml ファイル の生成が完了したら、それらが 1 つの plugin-cfg.xml ファイルにマージされます。 マージ後のこのファイルは、ジョブ・マネージャー・ディレクトリー app_server_root/profiles/job_manager_profile/config/temp/JobManager/job_ID/_mergedPluginDir/ に置かれます。

このジョブには、ターゲット・ホスト上の Liberty サーバーへの Java Management Extensions (JMX) 接続が必要です。 JMX 接続は、 ローカル・コネクターまたは HTTP/REST コネクターのいずれかを使用して構成できます。コネクター・フィーチャー名を Liberty サーバーの server.xml ファイル内に指定してください。以下の例は、ローカル・コネクターと HTTP/REST コネクターの 両方での、server.xml ファイル内のフィーチャー名を示しています。
<featureManager>
  <feature>localConnector-1.0</feature>
  <feature>restConnector-1.0</feature>
  ...
</featureManager>
HTTP/REST コネクターを 使用する場合は、ジョブをサブミットするときに JMX 接続用の ユーザー名とパスワードを指定する必要があります。
以下の条件 のいずれかが当てはまる場合、ジョブは停止し、エラーが戻されます。
  • ターゲットの Liberty サーバーが稼働していない。
  • ターゲットの Liberty サーバーに JMX コネクターが構成されていない。
  • JMX 接続用の有効なクレデンシャルがコマンドに指定されていない。

ジョブ・パラメーター

表 35. generateMergedPluginConfigForLibertyProfileServers パラメーターの説明. submitJob generateMergedPluginConfigForLibertyProfileServers コマンド は serverName パラメーターと、接続に関するパラメーターを指定して実行します。
パラメーター 説明 タイプ
serverName ターゲット・ホスト 上で plugin-cfg.xml ファイルを生成する対象のサーバーの名前 またはリソース ID を指定します。Liberty サーバーは、ターゲット・ホスト上で稼働している 必要があります。 ストリング
jmxuser JMX 接続のユーザー名を指定します。 JMX 接続に HTTP/REST コネクターを使用する場合、このパラメーターを指定してください。 ストリング
jmxpassword JMX 接続のパスワードを指定します。 JMX 接続に HTTP/REST コネクターを使用する場合、このパラメーターを指定してください。 ストリング

使用例

次の例は、ターゲット・ホスト host1 および host2 上 の Liberty サーバー defaultServer に対して、マージされた plugin-cfg.xml ファイル を生成します。

AdminTask.submitJob('[-jobType generateMergedPluginConfigForLibertyProfileServers
 -targetList [host1 host2] -description generateMergedPluginConfigForLibertyProfileServers
 -jobParams [[jmxpassword ********][serverName runtime/wlp/liberty_server/defaultServer][jmxuser c]]]') 

トピックのタイプを示すアイコン 参照トピック



タイム・スタンプ・アイコン 最終更新: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rxml_7jobtypes
ファイル名:rxml_7jobtypes.html