wsadmin スクリプトを使用する AdminTask オブジェクトの BLAManagement コマンド・グループ

Jython スクリプト言語を使用すると、wsadmin ツールでビジネス・レベル・アプリケーションを構成および管理することができます。 構成内でビジネス・レベル・アプリケーションの作成、編集、エクスポート、削除、および照会を行うには、BLAManagement グループのコマンドおよびパラメーターを使用します。

ビジネス・レベル・アプリケーションを構成および管理するには、コンフィギュレーター管理ロールを使用する必要があります。

アセットは、アセット・リポジトリーに格納されている 1 つ以上のアプリケーション・バイナリー・ファイルを表します。典型的な資産として、エンタープライズ・アーカイブ、ライブラリー・ファイル、その他のリソース・ファイルといった、アプリケーションのビジネス・ロジックがあります。アセット構成の管理には、以下のコマンドを使用します。
ビジネス・レベル・アプリケーションは、ゼロ個以上の構成単位またはその他のビジネス・レベル・アプリケーションから構成される構成成果物です。 ビジネス・レベル・アプリケーションは、アプリケーションを定義する管理モデルであり、エンタープライズ・アーカイブ (EAR) ファイル、共有ライブラリー、PHP アプリケーションなどを含めることができます。 ビジネス・レベル・アプリケーションの構成および管理には、以下のコマンドを使用します。
構成単位は、ビジネス・レベル・アプリケーション内のアセットを表します。 構成単位を使用すると、アセット・コンテンツはアプリケーション内の他のアセットとの対話が可能になります。また、これにより、製品ランタイムはアセット・コンテンツのロードおよび実行が可能になります。構成単位の構成の管理には、以下のコマンドを使用します。

deleteAsset

deleteAsset コマンドは、ビジネス・レベル・アプリケーションの構成からアセットを除去します。 このコマンドを使用する前に、対象となるアセットに関連付けられた構成単位がないことを確認してください。 アセットが構成単位と関連付けられている場合、このコマンドは失敗します。

ターゲット・オブジェクト

なし

必須パラメーター

-assetID
削除するアセットの構成 ID を指定します。 不完全な ID のストリングでも、システムが固有のアセットに一致させることができる限り、このコマンドは assetID パラメーターに対するその不完全な ID を受け入れます。(ストリング、必須)

オプション・パラメーター

-force
特定のアセットについて、他のアセットが依存している場合でも、システムで強制的に削除するかどうかを指定します。 (ブール値、オプション)

戻り値

以下の例に示すように、このコマンドは削除されるアセットの構成 ID を戻します。
WebSphere:assetname=asset2.zip

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.deleteAsset('-assetID asset2.zip -force true')
  • Jython リストを使用:
    AdminTask.deleteAsset(['-assetID', 'asset2.zip', '-force', 'true'])

対話モードの使用例

  • Jython の使用:
    AdminTask.deleteAsset('-interactive')

editAsset

editAsset コマンドは、追加のアセット構成オプションを変更します。 このコマンドを使用して、説明、宛先 URL、アセット関係、ファイル・アクセス権、および妥当性検査の設定を変更することができます。

ターゲット・オブジェクト

なし

必須パラメーター

-assetID
編集するアセットの構成 ID を指定します。 不完全な構成 ID のストリングでも、システムが固有のアセット ID に一致させることができる限り、このパラメーターはその不完全な構成 ID を受け入れます。(ストリング、必須)

オプションのステップ

オプションのステップでは、.* の文字を使用して、 読み取り専用の引数をコマンドの構文に指定します。"" の文字を使用して空ストリングを指定し、 引数の既存の値を保持します。 書き込み可能な引数に値または空ストリングを指定しない場合、コマンドによって引数が ヌル値にリセットされます。
-AssetOptions
アセットの追加プロパティーを設定するには、AssetOptions ステップおよび以下の引数を使用します。
inputAsset (読み取り専用)
アセットのソース・パッケージを指定します。
name (読み取り専用)
アセットの名前を指定します。 この引数のデフォルト値は、ソース・パッケージのファイル名です。
defaultBindingProps (読み取り専用)
アセットのデフォルトのバインディング・プロパティーを指定します。 この引数は、エンタープライズ・アセットにのみ適用されます。 エンタープライズ・アセット以外のアセットの場合、パターン・マッチングにはアスタリスク文字 (*) を指定します。エンタープライズ・アセットの場合、空でない値としてこの引数を設定するには、.* 値を指定します。
description
アセットの説明を指定します。
destinationUrl
デプロイするアセット・バイナリーの宛先 URL を指定します。
typeAspect
アセット・タイプのアスペクトを指定します。
relationship
アセット関係を指定します。 既存の関係にアセットを追加するには、正符号文字 (+) を使用します。 関係から既存のアセットを削除するには、番号記号文字 (#) を使用します。 既存の関係を置き換えるには、importAsset コマンドと同じ構文を指定します。 追加または更新の対象として指定されたアセットが関係内に存在しない場合、このコマンドは例外を戻します。
filePermission
ファイル・アクセス権の構成を指定します。
validate
アセットの妥当性検査を行うかどうかを指定します。 デフォルト値は false です。製品は validate の指定値を保存しません。したがって、現時点でアセットの妥当性検査を選択しても (true)、後からアセットを編集したときに、更新したファイルの妥当性検査を製品で実行するには、アセットの編集時にこの設定を再び有効にする必要があります。
-UpdateAppContentVersions
EBA アセットの場合、このステップおよび以下の引数を使用して、アセットのバンドル・バージョンを 選択します。
移行ユーザーの方へ 移行ユーザーの方へ: OSGi Applications and Java™ Persistence API 2.0 の WebSphere® Application Server バージョン 7 フィーチャー・パックでは、 アセットに対するバンドル変更は、ビジネス・レベル・アプリケーションを再始動することによって適用されます。 バージョン 8.x では、これらの変更は構成単位を更新することによって 適用されます。バージョン 8.x のこの新しい方法は、稼働中のビジネス・レベル・アプリケーションを再始動せずに、 多くのバンドル変更を正しい場所に適用できることを 意味します。この新しい方法を使用可能にするため、UpdateAppContentVersionsStep パラメーター は UpdateAppContentVersions パラメーターで置換され、 ビジネス・レベル・アプリケーションを再始動する代わりに、CompUnitStatusStep パラメーターを指定して editCompUnit コマンドを 実行するようになりました。trns
bundle_name
バンドルの名前を指定します。
current_version
バンドルのバージョン番号 (例えば 1.0.0) を指定するか、 または、アプリケーション・マニフェストに宣言されているが、ランタイム環境でデプロイされていない 共有バンドル (すなわち、使用バンドル) の場合は、NOT_DEPLOYED を 指定します。この引数は、バンドルの現在の構成を記述しますが、構成の変更には使用されません。
update_preference
新規のバンドル・バージョンの設定を指定します。これは、 バンドルのバージョン番号 (例えば 1.0.0)、 共有バンドルの場合の NOT_DEPLOYED、 または、システムにバンドル・バージョンの選択を任せる場合の NO_PREF のいずれか です。ある特定のバンドルについてバージョンを更新したくない 場合は、この属性を current_version 属性に使用する値と同じ値に設定してください。
アプリケーション・マニフェスト内のアプリケーション・コンテンツ・ヘッダーと使用バンドル・ヘッダーとの間にリストされている各バンドル について、エントリー (すなわち、bundle_name current_version および update_preference) を 組み込みます。バンドル・バージョンを更新するかどうかに関わらず、すべてのバンドルを組み込んでください。
以下のように構文を指定します。
AdminTask.editAsset('[
  -assetID asset_name 
  -UpdateAppContentVersions [
    [bundle_1_name current_version update_preference]
    [bundle_2_name current_version update_preference]
    [bundle_3_name current_version update_preference]
    [bundle_4_name current_version update_preference]
    [bundle_5_name current_version update_preference]
  ]]')

戻り値

このコマンドは、対象アセットの構成 ID を戻します。

バッチ・モードの使用例

非エンタープライズ・アセットを編集するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.editAsset('-assetID asset3.zip – AssetOptions [[.* asset3.zip * "asset for testing"
       c:/installedAssets/asset3.zip/BASE/asset3.zip "" assetname=a.jar "" false]]')
  • Jython リストを使用:
    AdminTask.editAsset(['-assetID', 'asset3.zip', '–AssetOptions', '[[.* asset3.zip * "asset for testing"
       c:/installedAssets/asset3.zip/BASE/asset3.zip "" assetname=a.jar "" false]]'])
エンタープライズ・アセットを編集するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.editAsset('-assetID defaultapp.ear – AssetOptions 
      [[.* defaultapp.ear .* "asset for testing" "" "" "" "" false]]')
  • Jython リストを使用:
    AdminTask.editAsset(['-assetID', 'defaultapp.ear', '–AssetOptions', 
       '[[.* defaultapp.ear .* "asset for testing" "" "" "" "" false]]'])

対話モードの使用例

  • Jython の使用:
    AdminTask.editAsset('-interactive')

exportAsset

exportAsset コマンドは、アセット構成をファイルにエクスポートします。

ターゲット・オブジェクト

なし

必須パラメーター

-assetID
エクスポートするアセットの構成 ID を指定します。 不完全な構成 ID でも、固有のアセットに一致する限り、このパラメーターはその不完全な構成 ID を受け入れます。(ストリング、必須)
-filename
システムがアセット構成をエクスポートする際の宛先ファイル名を指定します。 (DownloadFile、必須)

戻り値

このコマンドは出力を返しません。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.exportAsset('-assetID asset2.zip – filename c:/temp/a2.zip')
  • Jython リストを使用:
    AdminTask.exportAsset(['-assetID', 'asset2.zip', '–filename', 'c:/temp/a2.zip'])

対話モードの使用例

  • Jython の使用:
    AdminTask.exportAsset('-interactive')

importAsset

importAsset コマンドは、アセット構成をアセット・リポジトリーにインポートします。 アセットのインポート後には、それらのアセットをビジネス・レベル・アプリケーションに構成単位として追加できます。

ターゲット・オブジェクト

なし

必須パラメーター

-source
インポートするソース・ファイルの名前を指定します。 (UploadFile、必須)

オプション・パラメーター

-storageType
システムによるアセットのアセット・リポジトリーへの保存方法を指定します。 デフォルトのアセット・リポジトリーでは、フル・バイナリーの保管、バイナリーのメタデータの保管、またはバイナリーの保管なしのいずれかを指定できます。 フル・バイナリーを保管する場合は、FULL を指定します。 バイナリーのメタデータ部分を保管する場合は、METADATA を指定します。 アセット・リポジトリーにバイナリーを保管しない場合は、NONE を指定します。 デフォルト値は FULL です。 (ストリング、オプション)

オプションのステップ

オプションのステップでは、.* の文字を使用して、 読み取り専用の引数をコマンドの構文に指定します。"" の文字を使用して空ストリングを指定し、 引数の既存の値を保持します。 書き込み可能な引数に値または空ストリングを指定しない場合、コマンドによって引数が ヌル値にリセットされます。
-AssetOptions
アセットの追加プロパティーを設定するには、AssetOptions ステップおよび以下の引数を使用します。
inputAsset (読み取り専用)
アセットのソース・パッケージを指定します。
name
アセットの名前を指定します。 アセットの拡張ファイル名とソース・パッケージの拡張ファイル名が一致している必要があります。 この引数のデフォルト値は、ソース・パッケージのファイル名です。
defaultBindingProps (読み取り専用)
アセットのデフォルトのバインディング・プロパティーを指定します。 この引数は、エンタープライズ・アセットにのみ適用されます。 エンタープライズ・アセット以外のアセットの場合、パターン・マッチングにはアスタリスク文字 (*) を指定します。エンタープライズ・アセットの場合、空でない値としてこの引数を設定するには、.* 値を指定します。
description
アセットの説明を指定します。
destinationUrl
デプロイするアセット・バイナリーの宛先 URL を指定します。
typeAspect
アセット・タイプのアスペクトを指定します。 spec=xxx という構文のオブジェクト名フォーマットで typeAspect オプションを指定します。
relationship
アセット関係を指定します。 複数のアセット関係を指定するには、正符号文字 (+) を使用します。 関係内に存在しないアセットを指定した場合、このコマンドは例外を戻します。
filePermission
ファイル・アクセス権の構成を指定します。

OSGi アプリケーションは filePermission 値を使用しません。

validate
アセットの妥当性検査を行うかどうかを指定します。 デフォルト値は false です。製品は validate の指定値を保存しません。したがって、現時点でアセットの妥当性検査を選択しても (true)、後からアセットを編集したときに、更新したファイルの妥当性検査を製品で実行するには、アセットの編集時にこの設定を再び有効にする必要があります。

OSGi アプリケーションは validate 値を使用しません。

戻り値

以下の例に示すように、このコマンドはシステムが作成するアセットの構成 ID を戻します。
WebSphere:assetname=asset2.zip

バッチ・モードの使用例

非エンタープライズ・アセットをインポートするには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.importAsset('-source c:¥ears¥asset1.zip -storageType NONE')
  • Jython リストを使用:
    AdminTask.importAsset(['-source', 'c:¥ears¥asset1.zip', '-storageType', 'NONE'])
非エンタープライズ・アセットをインポートし、アセット名として asset2.zip を設定し、メタデータ・バイナリーをアセット・リポジトリーに保存し、デプロイするバイナリーの宛先ディレクトリーを設定する場合、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.importAsset('-source c:\ears\asset1.zip -storageType METADATA – AssetOptions 
      [[.* asset2.zip .* "asset for testing" c:/installedAssets/asset2.zip/BASE/asset2.zip "" "" "" "" false]]')
  • Jython リストを使用:
    AdminTask.importAsset(['-source', 'c:\ears\asset1.zip', '-storageType', 'METADATA', '–AssetOptions',
       '[[.* asset2.zip .* "asset for testing" c:/installedAssets/asset2.zip/BASE/asset2.zip "" "" "" "" false]]')
非エンタープライズ・アセットをインポートし、a.jar アセットおよび b.jar アセットとのアセット関係を指定する場合には、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.importAsset('[-source c:\ears\asset3.zip -storageType FULL – AssetOptions
       [[.* asset3.zip .* "asset for testing" "" spec=zip assetname=a.jar+assetname=b.jar "" false]]]')
  • Jython リストを使用:
    AdminTask.importAsset(['-source', 'c:\ears\asset3.zip', '-storageType', 'FULL', '–AssetOptions', 
      '[[.* asset3.zip .* "asset for testing" "" spec=zip assetname=a.jar+assetname=b.jar "" false]]'])
エンタープライズ・アセットをインポートするには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.importAsset('-source c:\ears\defaultapplication.ear – storageType FULL – AssetOptions
       [[.* defaultapp.ear .* "desc" "" "" "" false]]')
  • Jython リストを使用:
    AdminTask.importAsset(['-source', 'c:\ears\defaultapplication.ear', '–storageType', 
      'FULL', '–AssetOptions', '[[.* defaultapp.ear .* "desc" "" "" "" false]]'])

対話モードの使用例

  • Jython の使用:
    AdminTask.importAsset('-interactive')

listAssets

listAssets コマンドは、セル内の各アセットの構成 ID を表示します。

ターゲット・オブジェクト

なし

オプション・パラメーター

-assetID
対象となるアセットの構成 ID を指定します。 不完全な構成 ID でも、固有のアセットに一致する限り、このパラメーターはその不完全な構成 ID を受け入れます。(ストリング、オプション)
-includeDescription
コマンドが戻す各アセットの説明を含めるかどうかを指定します。 アセットの説明を表示する場合は、true を指定します。(ストリング、オプション)
-includeDeplUnit
コマンドが戻す各アセットのデプロイ可能な単位を表示するかどうかを指定します。 デプロイ可能な単位を表示する場合は、true を指定します。 (ストリング、オプション)

戻り値

このコマンドは、対象となるアセットの構成 ID のリストを戻します。 以下の例に示すように、このコマンドは、指定されたパラメーター値に応じて各アセットの説明およびデプロイ可能な構成単位を表示します。
WebSphere:assetname=asset1.zip
"asset for testing"

WebSphere:assetname=asset2.zip
"second asset for testing"
a.jar

WebSphere:aasetname=asset3.zip
"third asset for testing"
a1.jar+a2.jar

WebSphere:assetname=a.jar0
"a.jar for sharedlib"

WebSphere:assetname=b.jar
"b.jar for sharedlib"

WebSphere:assetname=defaultapp.ear
"default app"

バッチ・モードの使用例

セル内の各アセットをリストする場合には、以下の例を参考にしてください。
  • Jython を使用:
    AdminTask.listAssets()
セル内の各アセットをリストする場合には、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.listAssets('-assetID asset1.zip')
  • Jython リストを使用:
    AdminTask.listAssets(['-assetID asset1.zip'])
セル内の各アセット、アセットの説明、およびデプロイ可能な構成単位をリストする場合には、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.listAssets('-includeDescription true – includeDeplUnit true')
  • Jython リストを使用:
    AdminTask.listAssets(['-includeDescription', 'true', '–includeDeplUnit', 'true')

対話モードの使用例

  • Jython の使用:
    AdminTask.listAssets('-interactive')

updateAsset

updateAsset コマンドは、アセットの 1 つ以上のファイルまたはモジュール・ファイルを変更します。このコマンドは、アセットのバイナリー・ファイルを更新しますが、システムがそのアセットとともにバッキング・オブジェクトとしてデプロイする構成単位は更新しません。

ターゲット・オブジェクト

なし

必須パラメーター

-assetID
更新するアセットの構成 ID を指定します。 不完全な構成 ID でも、固有のアセットに一致する限り、このパラメーターはその不完全な構成 ID を受け入れます。(ストリング、必須)
-operation
対象となるアセットで呼び出すオペレーションを指定します。 (ストリング、必須)
以下の表は、アセットで呼び出し可能な各オペレーションを示したものです。
表 1. updateAsset でサポートされる操作. いずれかの操作を指定します。
オペレーション 説明
replace replace 操作は、対象アセットの内容を置換します。
merge merge 操作は、アセットの複数のファイルを更新します。ただし、すべてのファイルを更新するわけではありません。
add add 操作は、新規ファイルまたはモジュール・ファイルを追加します。
addupdate addupdate 操作は、1 つのファイルまたはモジュール・ファイルを追加または更新します。ファイルが存在しない場合、システムはその内容を追加します。 ファイルが存在する場合、システムはそのファイルを更新します。
update update 操作は、1 つのファイルまたはモジュール・ファイルを更新します。
delete delete 操作は、ファイルまたはモジュール・ファイルを削除します。
-contents
追加または更新するコンテンツを含むファイルを指定します。 delete オペレーションの場合、このパラメーターは不要です。(UploadFile、オプション)

オプション・パラメーター

-contenturi
アセットでの追加、更新、または除去の対象となるファイルの Uniform Resource Identifier (URI) を指定します。 merge または replace オペレーションの場合、このパラメーターは不要です。 (ストリング、オプション)

オプションのステップ

オプションのステップでは、.* の文字を使用して、 読み取り専用の引数をコマンドの構文に指定します。"" の文字を使用して空ストリングを指定し、 引数の既存の値を保持します。 書き込み可能な引数に値または空ストリングを指定しない場合、コマンドによって引数が ヌル値にリセットされます。
-AssetOptions
アセットの追加プロパティーを設定するには、AssetOptions ステップおよび以下の引数を使用します。
name (読み取り専用)
アセットの名前を指定します。 この引数のデフォルト値は、ソース・パッケージのファイル名です。
defaultBindingProps (読み取り専用)
アセットのデフォルトのバインディング・プロパティーを指定します。 この引数は、エンタープライズ・アセットにのみ適用されます。 エンタープライズ・アセット以外のアセットの場合、パターン・マッチングにはアスタリスク文字 (*) を指定します。エンタープライズ・アセットの場合、空でない値としてこの引数を設定するには、.* 値を指定します。
description
アセットの説明を指定します。
destinationUrl
デプロイするアセット・バイナリーの宛先 URL を指定します。
typeAspect
アセット・タイプのアスペクトを指定します。
relationship
アセット関係を指定します。 既存の関係にアセットを追加するには、正符号文字 (+) を使用します。 関係から既存のアセットを削除するには、番号記号文字 (#) を使用します。 既存の関係を置き換えるには、importAsset コマンドと同じ構文を指定します。 追加または更新の対象として指定されたアセットが関係内に存在しない場合、このコマンドは例外を戻します。
filePermission
ファイル・アクセス権の構成を指定します。
validate
アセットの妥当性検査を行うかどうかを指定します。 デフォルト値は false です。製品は validate の指定値を保存しません。したがって、現時点でアセットの妥当性検査を選択しても (true)、後からアセットを編集したときに、更新したファイルの妥当性検査を製品で実行するには、アセットの編集時にこの設定を再び有効にする必要があります。
updateAssociatedCUs
エンタープライズ (Java EE)・アセットに関連付けられている構成単位を更新するかどうかを指定します。この引数は、エンタープライズ・アセットにのみ適用されます。デフォルト値は none です。エンタープライズ・アセットに関連付けられている構成単位をすべて更新する場合は、all を指定します。

replace 操作の場合、 AssetOptions の name、defaultBindingProps、description、destinationUrl、 typeAspect、relationship、filePermission、validate、および updateAssociatedCUs 引数 の値を指定してください。replace 以外の操作の場合は、 AssetOptions の name および updateAssociatedCUs 引数を指定します。

戻り値

このコマンドは、対象アセットの構成 ID を戻します。

バッチ・モードの使用例

以下は、非エンタープライズ・アセットのコンテンツを置き換える場合の例です。
  • Jython ストリングを使用:
    AdminTask.updateAsset('-assetID asset1.zip -operation replace -contents c:/temp/a.zip')
  • Jython リストを使用:
    AdminTask.updateAsset(['-assetID', 'asset1.zip', '-operation', 'replace', '-contents', 'c:/temp/a.zip'])
以下は、非エンタープライズ・アセットのファイルを部分的に更新する場合の例です。
  • Jython ストリングを使用:
    AdminTask.updateAsset('-assetID asset1.zip – operation merge – contents c:/temp/p.zip')
  • Jython リストを使用:
    AdminTask.updateAsset(['-assetID', 'asset1.zip', '–operation', 'merge', '–contents', 'c:/temp/p.zip'])
以下は、エンタープライズ・アセットを Enterprise JavaBeans (EJB) モジュール・ファイルを使用して更新する場合の例です。
  • Jython ストリングを使用:
    AdminTask.updateAsset('-assetID defaultapp.ear – operation add – contents 
      c:/temp/filename.jar – contenturi filename.jar')
  • Jython リストを使用:
    AdminTask.updateAsset(['-assetID', 'defaultapp.ear', '–operation', 'add', '–contents', 
      'c:/temp/filename.jar', '–contenturi', 'filename.jar'])
以下は、replace オペレーションを使用して、エンタープライズ・アセットおよび関連付けられている構成単位を置き換える場合の例です。
  • Jython ストリングを使用:
    AdminTask.updateAsset('-assetID defaultapp.ear –operation replace –contents 
      c:/temp/newapp.ear – AssetOptions [[defaultapp.ear .* newdesc "" "" "" "" false all]]')
  • Jython リストを使用:
    AdminTask.updateAsset(['-assetID', 'defaultapp.ear', '–operation', 'replace', '–contents',
      'c:/temp/newapp.ear', '–AssetOptions [[defaultapp.ear .* newdesc "" "" "" "" false all]]'])
以下は、merge オペレーションを使用して、エンタープライズ・アセットおよび関連付けられている構成単位を更新する場合の例です。
  • Jython ストリングを使用:
    AdminTask.updateAsset('-assetID defaultapp.ear –operation merge –contents 
      c:/temp/newapp.ear – AssetOptions [[defaultapp.ear all]]')
  • Jython リストを使用:
    AdminTask.updateAsset(['-assetID', 'defaultapp.ear', '–operation', 'merge', '–contents',
      'c:/temp/newapp.ear', '–AssetOptions [[defaultapp.ear all]]'])

対話モードの使用例

  • Jython の使用:
    AdminTask.updateAsset('-interactive')

viewAsset

viewAsset コマンドは、アセットの追加の構成オプションおよび構成値を表示します。

ターゲット・オブジェクト

なし

必須パラメーター

-assetID
対象となるアセットの構成 ID を指定します。 不完全な構成 ID でも、固有のアセットに一致する限り、このパラメーターはその不完全な構成 ID を受け入れます。(ストリング、必須)

オプション・パラメーター

なし

戻り値

以下の例に示すように、このコマンドは対象となるアセットの構成データを戻します。
Specify Asset options (AssetOptions)

Specify options for Asset.

*Asset Name (name): [defaultapp.ear]
Default Binding Properties (defaultBindingProps): 
 [defaultbinding.ejbjndi.prefix#defaultbinding.datasource.jndi#defaultbinding.datasource.username
#defaultbinding.datasource.password#defaultbinding.cf.jndi
#defaultbinding.cf.resauth#defaultbinding.virtual.host#defaultbinding.force]
Asset Description (description): []
Asset Binaries Destination Url (destination): [${USER_INSTALL_ROOT}/installedAssets/defaultapp.ear/BASE/defaultapp.ear]
Asset Type Aspects (typeAspect): [WebSphere:spec=j2ee_ear]
Asset Relationships (relationship): []File Permission (filePermission): [.*¥¥.dll=755#.*¥¥.so=755#.*¥¥.a=755#.*¥¥.sl=755]
Validate asset (validate): [false]

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.viewAsset('-assetID asset3.zip')
  • Jython リストを使用:
    AdminTask.viewAsset(['-assetID', 'asset3.zip'])

対話モードの使用例

  • Jython の使用:
    AdminTask.viewAsset('-interactive')

addCompUnit

addCompUnit コマンドは、特定のビジネス・レベル・アプリケーションに構成単位を追加します。 構成単位はビジネス・レベル・アプリケーション内のアセットを表し、 アセット・コンテンツがアプリケーション内の他のアセットと相互作用することを可能にします。 また、これにより、製品ランタイムはアセット・コンテンツのロードおよび実行が可能になります。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 (ストリング、必須)
-cuSourceID
追加する構成単位のソース構成 ID を指定します。 アセット ID またはビジネス・レベル・アプリケーション ID を指定できます。 (ストリング、必須)

オプション・パラメーター

-deplUnits
アセットのデプロイ可能な単位のうち、デプロイするものを指定します。 デプロイ可能な単位のサブセット、またはすべてのデプロイ可能な単位を指定するか、共有ライブラリーとしての default を使用することができます。 このパラメーターを指定しなかった場合、システムはすべてのデプロイ可能な単位をデプロイします。 (ストリング、オプション)
Java EE アセットの場合、この -deplUnits パラメーターはシステムによって無視され、指定値にかかわりなく、このコマンドの一部として Java EE アセットを追加できるようになります。
-cuConfigStrategyFile
カスタム・デフォルト・バインディング・プロパティーの完全修飾ファイル・パスを指定します。 このパラメーターは、エンタープライズ・アセットにのみ適用されます。(ストリング、オプション)
-defaultBindingOptions
エンタープライズ・アセットのオプションの Java Naming and Directory Interface (JNDI) バインディング・プロパティーを指定します。使用可能なバインディング・プロパティーは、エンタープライズ・アセットのタイプによって変わります。デフォルト・バインディング・プロパティーの指定には、property=value というフォーマットを使用します。 複数のプロパティーを指定する場合は、それぞれの property=value ステートメントを区切り文字 # で区切ります。
バインディング・プロパティーは、アセットを作成する際には即時に、ビジネス・レベル・アプリケーションにアセットを構成単位として追加する際には後から指定することができます。 ビジネス・レベル・アプリケーションにアセットを追加する際に後からバインディング・プロパティーを指定する場合は、バインディング・プロパティーの指定にストラテジー・ファイルを使用できます。 (ストリング、オプション)
defaultBindingOptions パラメーターでは、以下のオプションを使用します。
表 2. addCompUnit -defaultBindingOptions でサポートされるバインディング・プロパティー. アセット・タイプにサポートされるバインディング・プロパティーを指定します。
エンタープライズ・アセットのタイプ サポートされているバインディング・プロパティー
エンタープライズ Bean (EJB)

defaultbinding.ejbjndi.prefix

defaultbinding.force

データ・ソース

defaultbinding.datasource.jndi

defaultbinding.datasource.username

defaultbinding.datasource.password

defaultbinding.force

接続ファクトリー

defaultbinding.cf.jndi

defaultbinding.cf.resauth

defaultbinding.force

仮想ホスト

defaultbinding.virtual.host

defaultbinding.force

オプションのステップ

オプション・ステップの値を指定して、新規の構成単位に追加プロパティーを設定することもできます。 これらのステップは、エンタープライズ・アセットには適用されません。オプションのステップでは、.* の文字を使用して、 読み取り専用の引数をコマンドの構文に指定します。"" の文字を使用して空ストリングを指定し、 引数の既存の値を保持します。 書き込み可能な引数に値または空ストリングを指定しない場合、コマンドによって引数が ヌル値にリセットされます。
-CUOptions
構成単位の追加プロパティーを指定します。 CUOptions ステップでは、以下のオプションを指定します。
parentBLA (読み取り専用)
新規の構成単位の親ビジネス・レベル・アプリケーションを指定します。
backingID (読み取り専用)
構成単位のソース ID を指定します。
name
構成単位の名前を指定します。
description
構成単位の説明を指定します。
startingWeight
構成単位の開始ウェイトを指定します。サポートされている値は 1 から 2147483647 (最大の整数値) です。
startedOnDistributed
ターゲット・ノードに変更を配布した後に構成単位を開始するかどうかを指定します。 デフォルト値は false です。
restartBehaviorOnUpdate
構成単位を編集した後にノードを再始動するように指定します。 すべてのターゲット・ノードを再始動する場合は、ALL を指定します。 同期プラグインによって制御されたノードを再始動する場合は、DEFAULT を指定します。 システムがノードを再始動しないようにする場合は、NONE を指定します。
例えば、このステップの構文は、-CUOptions [[.* .* cu4 "cu4 desc" 0 false DEFAULT]] のように指定します。
-MapTargets
構成単位のターゲット・マッピングの追加プロパティーを指定します。 MapTargets ステップでは、以下のオプションを指定します。
deplUnit (読み取り専用)
デプロイ可能単位の Uniform Resource Identifier (URI) を指定します。
Enterprise Bundle Archive (EBA) アセットの場合、この URI は ebaDeploymentUnit です。
server
構成単位をデプロイする 1 つ以上のターゲットを指定します。 デフォルト値は server1 サーバーです。 複数のターゲットを指定するには、正符号文字 (+) を使用します。 正符号文字 (+) を接頭部として使用して、ターゲットを追加します。 WebSphere Application Server サーバー以外のサーバーについては、それぞれ完全なオブジェクト名フォーマットを指定してください。
例えば、このステップの構文は、-MapTargets [[a1.jar cluster1+cluster2] [a2.jar +server2]] のように指定します。
-ActivationPlanOptions
構成単位のアクティベーション・プランの追加プロパティーを指定します。 ActivationPlanOptions ステップでは、以下のオプションを指定します。
deplUnit (読み取り専用)
デプロイ可能単位の Uniform Resource Identifier (URI) を指定します。
activationPlan
アクティベーション・プランとしてランタイム・コンポーネントのリストを指定します。それぞれのアクティベーション・プランは、specName=xxx,specVersion=yyy という形式で指定します (specName は仕様の名前であり、必須です)。 複数のアクティベーション・プランを指定する場合は、正符号文字 (+) を使用します。
例えば、このステップの構文は、-ActivationPlanOptions [[a1.jar specname=actplan0+specname=actplan1] [a2.jar specname=actplan1+specname=actplan2]] のように指定します。
EBA アセットの場合は、以下のデフォルト値を使用します。-ActivationPlanOptions [[default ""]]
-CreateAuxCUOptions
補助構成単位の追加プロパティーを指定します。 このステップは、構成単位のソースが、ビジネス・レベル・アプリケーション内に一致する構成単位を持たないアセットに対応したアセットである場合に使用します。 CreateAuxCUOptions ステップでは、以下のオプションを指定します。
deplUnit (読み取り専用)
デプロイ可能単位の Uniform Resource Identifier (URI) を指定します。
inputAsset (読み取り専用)
構成単位のソース ID を指定します。
cuID
システムがアセットに対して作成する構成単位の ID を指定します。 新規の構成単位を作成しない場合は、この引数を指定しないでください。
matchTarget
依存関係補助構成単位のターゲットと新規の構成単位のターゲットを突き合わせるかどうかを指定します。 デフォルト値は true です。
製品は matchTarget の指定値を保存しません。したがって、現時点でターゲットの突き合わせをしないことを選択しても (false)、後から構成単位を編集したときに、ターゲットの突き合わせを製品で実行しないようにするには、構成単位の編集時にこの設定を再び無効にする必要があります。
例えば、このステップの構文は、–CreateAuxCUOptions [[a1.jar a.jar auxCU true] [a2.jar a.jar defaultCU false]] のように指定します。
-RelationshipOptions
アセット、構成単位、およびビジネス・レベル・アプリケーション間の関係の追加プロパティーを指定します。 このステップは、構成単位のソース ID が、ビジネス・レベル・アプリケーション内に一致する構成単位を持つアセットである場合に使用します。 RelationshipOptions ステップでは、以下のオプションを指定します。
deplUnit (読み取り専用)
デプロイ可能単位の Uniform Resource Identifier (URI) を指定します。
relationship
構成単位関係を定義します。 構成単位のオブジェクト名を cuName=xxx というフォーマットで指定します。 関係内にある複数の構成単位のオブジェクト名を指定するには、正符号文字 (+) を使用します。 relationship に指定した構成単位が同じビジネス・レベル・アプリケーションの下に存在しない場合は、システムからエラーが返されます。
matchTarget
構成単位関係のターゲットと新規の構成単位のターゲットを突き合わせるかどうかを指定します。 デフォルト値は true です。
製品は matchTarget の指定値を保存しません。したがって、現時点でターゲットの突き合わせをしないことを選択しても (false)、後から構成単位を編集したときに、ターゲットの突き合わせを製品で実行しないようにするには、構成単位の編集時にこの設定を再び無効にする必要があります。
例えば、このステップの構文は、–RelationshipOptions [[a1.jar a.jar auxCU true] [a2.jar a.jar defaultCU false]] のように指定します。
-ContextRootStep
EBA アセットの場合、特定の Web Application Bundle (WAB) の Web ページが実行時にどこにあるかを決定するのはコンテキスト・ルートです。
ここで指定したコンテキスト・ルートは、定義済みのサーバー・マッピングと結合されて、WAB のページにアクセスする際に入力する完全 URL を構成します。 例えば、アプリケーション・サーバーのデフォルト・ホストが www.example.com:8080 で、WAB のコンテキスト・ルートが /sample であるとすると、Web ページは www.example.com:8080/sample にあります。
OSGi アプリケーションに含まれているすべての WAB モジュールのコンテキスト・ルートをリストするようにしてください。
このステップの構文は以下のように指定します。
  -ContextRootStep [
    [bundle_symbolic_name_1 bundle_version_1 context_root_1]
    [bundle_symbolic_name_2 bundle_version_2 context_root_2]]
例えば、2 つの WAB (/hello/web にマップされる、バージョン 1.0.0 の com.ibm.ws.eba.helloWorldService.web および /hello/service にマップされる、バージョン 0.9.0 の com.ibm.ws.eba.helloWorldService.withContextRoot) を含む EBA ファイルの場合、コマンドのこの側面は次のとおりです。
  -ContextRootStep [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 "/hello/web"] 
    [com.ibm.ws.eba.helloWorldService.withContextRoot 0.9.0 "/hello/service"]]
-VirtualHostMappingStep
EBA アセットの場合は、仮想ホストを使用して、モジュールやアプリケーションに固有のポートを関連付けることができます。 仮想ホストの別名は、その仮想ホストに定義されるポート番号を識 別します。 仮想ホストのエイリアスで指定されたポート番号は、 Web モジュール内のサーブレットや JavaServer Page (JSP) ファイルなどの成果物にアクセスする場合に URL で使用されます。 例えば、別名 myhost:8080 は URL http://myhost:8080/samplehost_name:port_number 部分です。
デプロイ済みアセットに含まれている各 WAB は、仮想ホストにマップする必要があります。 WAB は、同一の仮想ホストにインストールするか、いくつかの仮想ホストに分散させることができます。
特定の WAB について、ibm-web-bnd.xml ファイルまたは .xmi ファイルで既存の仮想ホストを指定した場合は、デフォルトでは、指定された仮想ホストが設定されます。 指定しなかった場合は、デフォルトの仮想ホスト設定 default_host が、いくつかのポート番号を仮想ホストの別名によって提供します。
80
ポート番号が指定されていないときに使用される内部の非セキュア・ポート
9080
内部ポート
9443
外部のセキュア・ポート
ご使用の WAB を同じノード (物理マシン) 上のその他の WAB またはリソースから分離しない限り、default_host が適した仮想ホストです。 default_host のほかに、 WebSphere Application Server は admin_host を提供し、これは管理コンソール・システム・アプリケーションの仮想ホストです。 admin_host はポート 9060 にあります。そのセキュア・ポートは 9043 です。WAB がシステム管理に関係するものでないかぎり、admin_host は選択しないでください。
このステップの構文は以下のように指定します。
-VirtualHostMappingStep [
    [bundle_symbolic_name_1 bundle_version_1 
    web_module_name_1 virtual_host_1]
    [bundle_symbolic_name_2 bundle_version_2 
     web_module_name_2 virtual_host_2]]
例えば、2 つの WAB (default_host にマップされる、バージョン 1.0.0 の com.ibm.ws.eba.helloWorldService.web および test_host にマップされる、バージョン 0.9.0 の com.ibm.ws.eba.helloWorldService.withContextRoot) を含む EBA ファイルの場合、コマンドのこの側面は次のとおりです。
-VirtualHostMappingStep [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 "HelloWorld service" default_host]
    [com.ibm.ws.eba.helloWorldService.withContextRoot 0.9.0 "HelloWorld second service" test_host]]
-MapRolesToUsersStep
EBA アセットの場合は、このステップを使用してセキュリティー・ロールをユーザーまたはグループにマップします。
このステップの構文は以下のように指定します。
-MapRolesToUsersStep [
    [role_name everyone? 
    all_authenticated_in_realm? 
    usernames groups]]
鍵:
  • role_name は、アプリケーションで定義されるロール名です。
  • everyone? は、全員がロールに含まれるかどうかを指定するために、Yes または No に設定されます。
  • all_authenticated_in_realm? には Yes または No を設定し、 すべての認証ユーザーがアプリケーション・レルムにアクセスできるかどうかを指定します。
  • usernames は、「|」文字で区切られた、WebSphere Application Server ユーザー名のリストです。
  • groups は、「|」文字で区切られた、WebSphere Application Server グループのリストです。
注: usernamesgroups では、空ストリング "" は「デフォルト値または既存の値を使用する」を意味します。 通常、デフォルト値は、どのユーザーもグループもロールにバインドされないということです。 ただし、アプリケーションに ibm-application-bnd.xmi ファイルが含まれているときは、usernames のデフォルト値はこのファイルから取得されます。 ibm-application-bnd.xmi ファイルを含むアプリケーションをデプロイしているとき、バインド済みユーザーを除去したい場合は、文字「|」のみを指定します (文字「|」は複数のユーザー名を指定する場合の分離文字です)。 こうすることは明示的に「ユーザーなし」を指定することになるため、どのユーザーもロールにバインドされないことを保証します。
以下に例を示します。
-MapRolesToUsersStep [
    [ROLE1 No Yes "" ""] 
    [ROLE2 No No WABTestUser1 ""] 
    [ROLE3 No No "" WABTestGroup1] 
    [ROLE4 Yes No "" ""]]
-BlueprintResourceRefBindingStep
EBA アセットの場合、Blueprint コンポーネントは、WebSphere Application Server リソース参照にアクセスできます。各参照は、Blueprint XML ファイル内で宣言され、Java Platform Enterprise Edition (Java EE) コネクター・アーキテクチャー (JCA) 認証別名を使用して保護できます。OSGi アプリケーション内の各バンドルは、さまざまな Blueprint XML ファイルに多数のリソース参照宣言を含むことができます。
リソース参照を保護すると、それらのリソース参照は、OSGi アプリケーションの デプロイ先となるすべてのサーバーまたはクラスターに存在する JCA 認証別名にのみ バインドされることができます。OSGi アプリケーションは、同じセキュリティー・ ドメイン内にある複数のサーバーおよびクラスターにデプロイすることができます。したがって、各 JCA 認証別名は、ターゲットのサーバーおよびクラスターのセキュリティー・ドメインか、またはグローバル・セキュリティー・ドメインのいずれかに存在しなければなりません。
このステップの構文は以下のように指定します。
-BlueprintResourceRefBindingStep [
    [
    bundle_symbolic_name 
    bundle_version 
    blueprint_resource_reference_id 
    interface_name 
    jndi_name 
    authentication_type 
    sharing_setting 
    authentication_alias_name
    ]]
注: jndi_name の値 は、Blueprint XML ファイル内のリソース参照エレメントの filter 属性内で宣言 する jndi 名と一致していなければなりません。
例えば、認証別名 alias1 にバインドされる、バージョン 1.0.0 のバンドル com.ibm.ws.eba.helloWorldService.properties.bundle.jar を含む EBA ファイルの場合、コマンドは次のとおりです。
-BlueprintResourceRefBindingStep[
    [com.ibm.ws.eba.helloWorldService.properties.bundle 1.0.0 resourceRef 
    javax.sql.DataSource jdbc/Account Container Shareable alias1]]
-WebModuleMsgDestRefs
EBA アセットの場合は、リソース参照のバインドによって、Web アプリケーションのリソース依存関係がサーバー・ランタイム環境で使用可能な実際のリソースにマップされます。 少なくとも、これは、ランタイム環境でリソースが認識される JNDI 名を指定するマッピングを使用することで達成することができます。 デフォルトでは、この JNDI 名は、Web Application Bundle (WAB) の開発時に web.xml ファイルで指定したリソース ID です。 このオプションを使用して、 Java 仕様 JSR-250: 「Common Annotations for the Java Platform」で定義されているように、タイプ message-destination-ref (メッセージ宛先参照) または resource-env-ref (リソース環境参照) のリソースをバインドします。
このステップの構文は以下のように指定します。
-WebModuleMsgDestRefs [
    [
    bundle_symbolic_name
    bundle_version
    resource_reference_id
    resource_type
    target_jndi_name
	   ]]
以下に例を示します。
-WebModuleMsgDestRefs [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 
    jms/myQ javax.jms.Queue jms/workQ] 
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 
    jms/myT javax.jms.Topic jms/notificationTopic]]
-WebModuleResourceRefs
EBA アセットの場合は、リソース参照のバインドによって、Web アプリケーションのリソース依存関係がサーバー・ランタイム環境で使用可能な実際のリソースにマップされます。 少なくとも、これは、ランタイム環境でリソースが認識される JNDI 名を指定するマッピングを使用することで達成することができます。 デフォルトでは、この JNDI 名は、Web Application Bundle (WAB) の開発時に web.xml ファイルで指定したリソース ID です。 このオプションを使用して、 Java 仕様 JSR-250: 「Common Annotations for the Java Platform」で定義されているように、タイプ resource-ref (リソース参照) のリソースをバインドします。
このステップの構文は以下のように指定します。
-WebModuleResourceRefs [
    [
    bundle_symbolic_name
    bundle_version
    resource_reference_id
    resource_type
    target_jndi_name
    login_configuration
    login_properties
    extended_properties
	   ]]
以下に例を示します。
-WebModuleResourceRefs [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 jdbc/jtaDs javax.sql.DataSource 
    jdbc/helloDs "" "" ""] 
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 jdbc/nonJtaDs javax.sql.DataSource 
    jdbc/helloDsNonJta "" "" "extprop1=extval1"]]
注: 複数 の拡張プロパティーを使用する場合の jython 構文は "extprop1=extval1,extprop2=extval2" です。

戻り値

以下の例に示すように、このコマンドは構成単位の構成 ID と、アセット関係内のアセットに対して作成された新規の構成単位の構成 ID を戻します。
WebSphere:cuname=cu4
WebSphere:cuname=cua
WebSphere:cuname=cud

バッチ・モードの使用例

非エンタープライズ・アセットを追加するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.addCompUnit('-blaID myBLA – cuSourceID assetname=asset1.zip -CUOptions 
      [[.* .* cu1 "cu1 desc1" 0 false DEFAULT]] -MapTargets [[.* server1]] –ActivationPlanOptions 
      [.* specname=actplan0+specname=actplan1]')
  • Jython リストを使用:
    AdminTask.addCompUnit(['-blaID', 'myBLA', '–cuSourceID', 'assetname=asset1.zip', '-CUOptions', 
      '[[.* .* cu1 "cu1 desc1" 0 false DEFAULT]]', '-MapTargets', '[[.* server1]]', '–ActivationPlanOptions',
       '[.* specname=actplan0+specname=actplan1]'])
ビジネス・レベル・アプリケーションの構成単位を追加するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.addCompUnit('-blaID myBLA -cuSourceID yourBLA -CUOptions [[.* .* cu3 "cu3 desc3" 0 false DEFAULT]]')
  • Jython リストを使用:
    AdminTask.addCompUnit(['-blaID', 'myBLA', '-cuSourceID', 'yourBLA', '-CUOptions', 
      '[[.* .* cu3 "cu3 desc3" 0 false DEFAULT]]'])
次の例を使用して、EBA 構成単位を作成し、作成した EBA 構成単位をビジネス・レベル・アプリケーションに追加します。
AdminTask.addCompUnit('[
  -blaID WebSphere:blaname=helloWorldService 
  -cuSourceID WebSphere:assetname=com.ibm.ws.eba.helloWorldService.eba
  -CUOptions [
    [WebSphere:blaname=helloWorldService.eba 
    WebSphere:assetname=com.ibm.ws.eba.helloWorldService.eba 
    com.ibm.ws.eba.helloWorldService_0001.eba "" 1 false DEFAULT]] 
  -MapTargets [[ebaDeploymentUnit WebSphere:node=node01,server=server1]] 
  -ActivationPlanOptions [[default ""]]  
  -ContextRootStep [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 "/hello/web"] 
    [com.ibm.ws.eba.helloWorldService.withContextRoot 0.9.0 "/hello/service"]]
  -VirtualHostMappingStep [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 
    "HelloWorld service" default_host]
    [com.ibm.ws.eba.helloWorldService.withContextRoot 0.9.0 
    "HelloWorld second service" test_host]]
  -MapRolesToUsersStep [
    [ROLE1 No Yes "" ""] 
    [ROLE2 No No WABTestUser1 ""] 
    [ROLE3 No No "" WABTestGroup1] 
    [ROLE4 Yes No "" ""]]
  -BlueprintResourceRefBindingStep[
    [com.ibm.ws.eba.helloWorldService.properties.bundle 1.0.0 resourceRef 
    javax.sql.DataSource jdbc/Account Container Shareable alias1]]
  -WebModuleMsgDestRefs [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 
    jms/myQ javax.jms.Queue jms/workQ] 
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 
    jms/myT javax.jms.Topic jms/notificationTopic]]
  -WebModuleResourceRefs [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 jdbc/jtaDs javax.sql.DataSource 
    jdbc/helloDs "" "" ""] 
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 jdbc/nonJtaDs javax.sql.DataSource 
    jdbc/helloDsNonJta "" "" "extprop1=extval1"]]
]')
非エンタープライズ・アセットの構成単位を追加して、その構成単位を複数のターゲットにデプロイするには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.addCompUnit('-blaID theirBLA – cuSourceID asset2.zip – CUOptions 
      [[.* .* cu2 "cu2 desc" 0 false DEFAULT]] -MapTargets [[.* server1+server2]]')
  • Jython リストを使用:
    AdminTask.addCompUnit(['-blaID', 'theirBLA', '–cuSourceID', 'asset2.zip', '–CUOptions', 
      '[[.* .* cu2 "cu2 desc" 0 false DEFAULT]]', '-MapTargets', '[[.* server1+server2]]'])
デプロイ可能な単位を持つ非エンタープライズ・アセットである構成単位を追加するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.addCompUnit('-blaID yourBLA – cuSourceID asset2.zip – deplUnits a.jar – CUOptions 
      [[.* .* cu3 "cu3 desc" 0 false DEFAULT]] –MapTargets [[a.jar server1]] –ActivationPlanOptions 
      [[a.jar specname=actplan1]]')
  • Jython リストを使用:
    AdminTask.addCompUnit(['-blaID', 'yourBLA', '–cuSourceID', 'asset2.zip', '–deplUnits', 'a.jar', '–CUOptions', 
      '[[.* .* cu3 "cu3 desc" 0 false DEFAULT]]', '–MapTargets', '[[a.jar server1]]', '–ActivationPlanOptions',
       '[[a.jar specname=actplan1]]'])
非エンタープライズ・アセットの構成単位を共有ライブラリーとして追加するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.addCompUnit('-blaID ourBLA – cuSourceID b.jar – deplUnits default – CUOptions 
      [[.* .* cub "cub desc" 0 false DEFAULT]] –MapTargets [[default server1]]')
  • Jython リストを使用:
    AdminTask.addCompUnit(['-blaID', 'ourBLA', '–cuSourceID', 'b.jar', '–deplUnits', 'default', '–CUOptions', 
      '[[.* .* cub "cub desc" 0 false DEFAULT]]', '–MapTargets', '[[default server1]]'])
依存関係を持つ非エンタープライズ・アセットの構成単位を追加するには、以下の例を参考にしてください。 この例では、cub 構成単位が、ourBLA ビジネス・レベル・アプリケーションの共有ライブラリーとして cub 構成単位が存在しています。
  • Jython ストリングを使用:
    AdminTask.addCompUnit('-blaID ourBLA – cuSourceID asset3.zip – deplUnits a1.jar – CUOptions 
      [[.* .* cu4 "cu4 desc" 0 false DEFAULT]] –MapTargets [[a1.jar cluster1+cluster2]] –CreateAuxCUOptions 
      [[a1.jar a.jar cua true]] –RelationshipOptions [[a1.jar cuname=cub true]]')
  • Jython リストを使用:
    AdminTask.addCompUnit(['-blaID', 'ourBLA', '–cuSourceID', 'asset3.zip', '–deplUnits', 'a1.jar', '–CUOptions',
     '[[.* .* cu4 "cu4 desc" 0 false DEFAULT]]', '–MapTargets', '[[a1.jar cluster1+cluster2]]', '–CreateAuxCUOptions', 
      '[[a1.jar a.jar cua true]]', '–RelationshipOptions', '[[a1.jar cuname=cub true]]'])
エンタープライズ・アセットを追加するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.addCompUnit('[-blaID yourBLA – cuSourceID defaultapp.ear – defaultBindingOptions
      defaultbinding.ejbjndi.prefix=ejb# defaultbinding.virtual.host=default_host#
      defaultbinding.force=yes – AppDeploymentOptions [-appname defaultapp -installed.ear.destination
      application_root/myCell/defaultapp.ear] –MapModulesToServers 
      [[defaultapp.war .* WebSphere:cell=cellName,node=nodeName,server=server1]
      [Increment.jar .* Websphere:cell=cellName,node=nodeName,server=server2]] -CtxRootForWebMod
      [[defaultapp.war .* myctx/]]]')
  • Jython リストを使用:
    AdminTask.addCompUnit(['-blaID', 'yourBLA', '–cuSourceID', 'defaultapp.ear', '–defaultBindingOptions',
       'defaultbinding.ejbjndi.prefix=ejb# defaultbinding.virtual.host=default_host# defaultbinding.force=yes', 
       '–AppDeploymentOptions', '[-appname defaultapp -installed.ear.destination application_root/myCell/defaultapp.ear]',
       '–MapModulesToServers', '[[defaultapp.war .* WebSphere:cell=cellName,node=nodeName,server=server1]
       [Increment.jar .* Websphere:cell=cellName,node=nodeName,server=server2]]', '-CtxRootForWebMod', 
       '[[defaultapp.war .* myctx/]]'])

対話モードの使用例

  • Jython の使用:
    AdminTask.addCompUnit('-interactive')

deleteCompUnit

deleteCompUnit コマンドは、構成単位を除去します。 不完全な構成 ID のストリングでも、システムが固有の ID に一致させることができる限り、このコマンドのどちらのパラメーターもその不完全な構成 ID を受け入れます。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 (ストリング、必須)
-cuID
削除する構成単位の構成 ID を指定します。(ストリング、必須)

オプション・パラメーター

-force
システムで構成単位 (他の構成単位と依存関係がある構成単位を含む) を強制削除するかどうかを指定します。(ブール値、オプション)

戻り値

以下の例に示すように、このコマンドはシステムが削除した構成単位の構成 ID を戻します。
WebSphere:cuname=cu1

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.deleteCompUnit('-blaID myBLA – cuID cu1 -force true')
  • Jython リストを使用:
    AdminTask.deleteCompUnit(['-blaID', 'myBLA', '–cuID', 'cu1', '-force', 'true'])

対話モードの使用例

  • Jython の使用:
    AdminTask.deleteCompUnit('-interactive')

editCompUnit

editCompUnit コマンドは、追加の構成単位オプションを変更します。 このコマンドを使用して、構成単位の開始ウェイト、デプロイメント・ターゲット、アクティベーション・プランのオプション、および関係の設定を変更することができます。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 (ストリング、必須)
-cuID
編集する構成単位の構成 ID を指定します。(ストリング、必須)

オプションのステップ

オプション・ステップの値を指定して、構成単位のプロパティーを編集することもできます。 これらのステップは、エンタープライズ・アセットには適用されません。オプションのステップでは、.* の文字を使用して、 読み取り専用の引数をコマンドの構文に指定します。"" の文字を使用して空ストリングを指定し、 引数の既存の値を保持します。 書き込み可能な引数に値または空ストリングを指定しない場合、コマンドによって引数が ヌル値にリセットされます。
-CUOptions
構成単位の追加プロパティーを指定します。 CUOptions ステップでは、以下のオプションを指定します。
parentBLA (読み取り専用)
構成単位の親ビジネス・レベル・アプリケーションを指定します。
backingID (読み取り専用)
構成単位のソース ID を指定します。
name (読み取り専用)
構成単位の名前を指定します。
description
構成単位の説明を指定します。
startingWeight
構成単位の開始ウェイトを指定します。サポートされている値は 1 から 2147483647 (最大の整数値) です。
startedOnDistributed
ターゲット・ノードに変更を配布した後に構成単位を開始するかどうかを指定します。 デフォルト値は false です。
restartBehaviorOnUpdate
構成単位を編集した後にノードを再始動するように指定します。 すべてのターゲット・ノードを再始動する場合は、ALL を指定します。 同期プラグインによって制御されたノードを再始動する場合は、DEFAULT を指定します。 システムがノードを再始動しないようにする場合は、NONE を指定します。
例えば、このステップの構文は、-CUOptions [[.* .* cu4 "cu4 description" 0 false DEFAULT]] のように指定します。
-MapTargets
構成単位のターゲット・マッピングの追加プロパティーを指定します。 MapTargets ステップでは、以下のオプションを指定します。
deplUnit (読み取り専用)
デプロイ可能単位の Uniform Resource Identifier (URI) を指定します。
Enterprise Bundle Archive (EBA) アセットの場合、この URI は ebaDeploymentUnit です。
server
構成単位をデプロイする 1 つ以上のターゲットを指定します。 デフォルト値は server1 サーバーです。 複数のターゲットを指定するには、正符号文字 (+) を使用します。 正符号文字 (+) を接頭部として使用して、ターゲットを追加します。 WebSphere Application Server サーバー以外のサーバーについては、それぞれ完全なオブジェクト名フォーマットを指定してください。
例えば、このステップの構文は、-MapTargets [[a1.jar cluster1+cluster2] [a2.jar server1+server2]] のように指定します。
-ActivationPlanOptions
構成単位のアクティベーション・プランの追加プロパティーを指定します。 ActivationPlanOptions ステップでは、以下のオプションを指定します。
deplUnit (読み取り専用)
デプロイ可能単位の Uniform Resource Identifier (URI) を指定します。
activationPlan
アクティベーション・プランとしてランタイム・コンポーネントのリストを指定します。それぞれのアクティベーション・プランは、specName=xxx,specVersion=yyy という形式で指定します (specName は仕様の名前であり、必須です)。 複数のアクティベーション・プランを指定する場合は、正符号文字 (+) を使用します。
例えば、このステップの構文は、-ActivationPlanOptions [[a1.jar specname=actplan0+actplan1] [a2.jar specname=actplan1+specname=actplan2]] のように指定します。
EBA アセットの場合は、アクティベーション・プランを変更しないようにしてください。 構成単位の追加時に設定された以下のデフォルト値を保持してください。-ActivationPlanOptions [[default ""]]
-RelationshipOptions
アセット、構成単位、およびビジネス・レベル・アプリケーション間の関係の追加プロパティーを指定します。 このステップは、構成単位のソース ID が、ビジネス・レベル・アプリケーション内に一致する構成単位を持つアセットである場合に使用します。 RelationshipOptions ステップでは、以下のオプションを指定します。
deplUnit (読み取り専用)
デプロイ可能単位の Uniform Resource Identifier (URI) を指定します。
relationship
構成単位関係を定義します。 構成単位のオブジェクト名を cuName=xxx というフォーマットで指定します。 関係内にある複数の構成単位のオブジェクト名を指定するには、正符号文字 (+) を使用します。 relationship に指定した構成単位が同じビジネス・レベル・アプリケーションの下に存在しない場合は、システムからエラーが返されます。
matchTarget
構成単位関係のターゲットと新規の構成単位のターゲットを突き合わせるかどうかを指定します。 デフォルト値は true です。
製品は matchTarget の指定値を保存しません。したがって、現時点でターゲットの突き合わせをしないことを選択しても (false)、後から構成単位を編集したときに、ターゲットの突き合わせを製品で実行しないようにするには、構成単位の編集時にこの設定を再び無効にする必要があります。
例えば、このステップの構文は、–RelationshipOptions [[a1.jar a.jar auxCU true] [a2.jar a.jar defaultCU false]] のように指定します。
-ContextRootStep
EBA アセットの場合、特定の Web Application Bundle (WAB) の Web ページが実行時にどこにあるかを決定するのはコンテキスト・ルートです。
ここで指定したコンテキスト・ルートは、定義済みのサーバー・マッピングと結合されて、WAB のページにアクセスする際に入力する完全 URL を構成します。 例えば、アプリケーション・サーバーのデフォルト・ホストが www.example.com:8080 で、WAB のコンテキスト・ルートが /sample であるとすると、Web ページは www.example.com:8080/sample にあります。
OSGi アプリケーションに含まれているすべての WAB モジュールのコンテキスト・ルートをリストするようにしてください。
このステップの構文は以下のように指定します。
  -ContextRootStep [
    [bundle_symbolic_name_1 bundle_version_1 context_root_1]
    [bundle_symbolic_name_2 bundle_version_2 context_root_2]]
例えば、2 つの WAB (/hello/web にマップされる、バージョン 1.0.0 の com.ibm.ws.eba.helloWorldService.web および /hello/service にマップされる、バージョン 0.9.0 の com.ibm.ws.eba.helloWorldService.withContextRoot) を含む EBA ファイルの場合、コマンドのこの側面は次のとおりです。
  -ContextRootStep [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 "/hello/web"] 
    [com.ibm.ws.eba.helloWorldService.withContextRoot 0.9.0 "/hello/service"]]
-VirtualHostMappingStep
EBA アセットの場合は、仮想ホストを使用して、モジュールやアプリケーションに固有のポートを関連付けることができます。 仮想ホストの別名は、その仮想ホストに定義されるポート番号を識 別します。 仮想ホストのエイリアスで指定されたポート番号は、 Web モジュール内のサーブレットや JavaServer Page (JSP) ファイルなどの成果物にアクセスする場合に URL で使用されます。 例えば、別名 myhost:8080 は URL http://myhost:8080/samplehost_name:port_number 部分です。
デプロイ済みアセットに含まれている各 WAB は、仮想ホストにマップする必要があります。 WAB は、同一の仮想ホストにインストールするか、いくつかの仮想ホストに分散させることができます。
特定の WAB について、ibm-web-bnd.xml ファイルまたは .xmi ファイルで既存の仮想ホストを指定した場合は、デフォルトでは、指定された仮想ホストが設定されます。 指定しなかった場合は、デフォルトの仮想ホスト設定 default_host が、いくつかのポート番号を仮想ホストの別名によって提供します。
80
ポート番号が指定されていないときに使用される内部の非セキュア・ポート
9080
内部ポート
9443
外部のセキュア・ポート
ご使用の WAB を同じノード (物理マシン) 上のその他の WAB またはリソースから分離しない限り、default_host が適した仮想ホストです。 default_host のほかに、 WebSphere Application Server は admin_host を提供し、これは管理コンソール・システム・アプリケーションの仮想ホストです。 admin_host はポート 9060 にあります。そのセキュア・ポートは 9043 です。WAB がシステム管理に関係するものでないかぎり、admin_host は選択しないでください。
このステップの構文は以下のように指定します。
-VirtualHostMappingStep [
    [bundle_symbolic_name_1 bundle_version_1 
    web_module_name_1 virtual_host_1]
    [bundle_symbolic_name_2 bundle_version_2 
     web_module_name_2 virtual_host_2]]
例えば、2 つの WAB (default_host にマップされる、バージョン 1.0.0 の com.ibm.ws.eba.helloWorldService.web および test_host にマップされる、バージョン 0.9.0 の com.ibm.ws.eba.helloWorldService.withContextRoot) を含む EBA ファイルの場合、コマンドのこの側面は次のとおりです。
-VirtualHostMappingStep [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 "HelloWorld service" default_host]
    [com.ibm.ws.eba.helloWorldService.withContextRoot 0.9.0 "HelloWorld second service" test_host]]
-MapRolesToUsersStep
EBA アセットの場合は、このステップを使用してセキュリティー・ロールをユーザーまたはグループにマップします。
このステップの構文は以下のように指定します。
-MapRolesToUsersStep [
    [role_name everyone? 
    all_authenticated_in_realm? 
    usernames groups]]
鍵:
  • role_name は、アプリケーションで定義されるロール名です。
  • everyone? は、全員がロールに含まれるかどうかを指定するために、Yes または No に設定されます。
  • all_authenticated_in_realm? には Yes または No を設定し、 すべての認証ユーザーがアプリケーション・レルムにアクセスできるかどうかを指定します。
  • usernames は、「|」文字で区切られた、WebSphere Application Server ユーザー名のリストです。
  • groups は、「|」文字で区切られた、WebSphere Application Server グループのリストです。
注: usernamesgroups では、空ストリング "" は「デフォルト値または既存の値を使用する」を意味します。 通常、デフォルト値は、どのユーザーもグループもロールにバインドされないということです。 ただし、アプリケーションに ibm-application-bnd.xmi ファイルが含まれているときは、usernames のデフォルト値はこのファイルから取得されます。 ibm-application-bnd.xmi ファイルを含むアプリケーションをデプロイしているとき、バインド済みユーザーを除去したい場合は、文字「|」のみを指定します (文字「|」は複数のユーザー名を指定する場合の分離文字です)。 こうすることは明示的に「ユーザーなし」を指定することになるため、どのユーザーもロールにバインドされないことを保証します。
以下に例を示します。
-MapRolesToUsersStep [
    [ROLE1 No Yes "" ""] 
    [ROLE2 No No WABTestUser1 ""] 
    [ROLE3 No No "" WABTestGroup1] 
    [ROLE4 Yes No "" ""]]
-BlueprintResourceRefPostDeployStep
EBA アセットの場合、Blueprint コンポーネントは、WebSphere Application Server リソース参照にアクセスできます。各参照は、Blueprint XML ファイル内で宣言され、Java Platform Enterprise Edition (Java EE) コネクター・アーキテクチャー (JCA) 認証別名を使用して保護できます。OSGi アプリケーション内の各バンドルは、さまざまな Blueprint XML ファイルに多数のリソース参照宣言を含むことができます。
リソース参照を保護すると、それらのリソース参照は、OSGi アプリケーションの デプロイ先となるすべてのサーバーまたはクラスターに存在する JCA 認証別名にのみ バインドされることができます。OSGi アプリケーションは、同じセキュリティー・ ドメイン内にある複数のサーバーおよびクラスターにデプロイすることができます。したがって、各 JCA 認証別名は、ターゲットのサーバーおよびクラスターのセキュリティー・ドメインか、またはグローバル・セキュリティー・ドメインのいずれかに存在しなければなりません。
このステップの構文は以下のように指定します。
-BlueprintResourceRefPostDeployStep [
    [
    bundle_symbolic_name 
    bundle_version 
    blueprint_resource_reference_id 
    interface_name 
    jndi_name 
    authentication_type 
    sharing_setting 
    authentication_alias_name
    ]]
注: jndi_name の値 は、Blueprint XML ファイル内のリソース参照エレメントの filter 属性内で宣言 する jndi 名と一致していなければなりません。
例えば、認証別名 alias1 にバインドされる、バージョン 1.0.0 のバンドル com.ibm.ws.eba.helloWorldService.properties.bundle.jar を含む EBA ファイルの場合、コマンドは次のとおりです。
-BlueprintResourceRefPostDeployStep[
    [com.ibm.ws.eba.helloWorldService.properties.bundle 1.0.0 resourceRef 
    javax.sql.DataSource jdbc/Account Container Shareable alias1]]
-WebModuleResourceRefs
EBA アセットの場合は、リソース参照のバインドによって、Web モジュールのリソース依存関係がサーバー・ランタイム環境で使用可能な実際のリソースにマップされます。 少なくとも、これは、ランタイム環境でリソースが認識される JNDI 名を指定するマッピングを使用することで達成することができます。 デフォルトでは、この JNDI 名は、Web Application Bundle (WAB) の開発時に web.xml ファイルで指定したリソース ID です。
このステップの構文は以下のように指定します。
-WebModuleResourceRefs [
    [
    bundle_symbolic_name
    bundle_version
    resource_reference_id
    resource_type
    target_jndi_name
    login_configuration
    login_properties
    extended_properties
	   ]]
以下に例を示します。
-WebModuleResourceRefs [
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 jdbc/jtaDs javax.sql.DataSource 
    jdbc/helloDs "" "" ""] 
    [com.ibm.ws.eba.helloWorldService.web 1.0.0 jdbc/nonJtaDs javax.sql.DataSource 
    jdbc/helloDsNonJta "" "" "extprop1=extval1"]]
注: 複数 の拡張プロパティーを使用する場合の jython 構文は "extprop1=extval1,extprop2=extval2" です。

戻り値

このコマンドは、システムが編集する構成単位の構成 ID を戻します。

バッチ・モードの使用例

アセットの構成単位を編集し、既存ターゲット内のターゲットを置き換えるには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.editCompUnit('-blaID myBLA – cuID cu1 – CUOptions [[.* .* cu1 cudesc 1 false DEFAULT]] -MapTargets 
      [[.* server2]] -ActivationPlanOptions [.* #specname=actplan0+specname=actplan2]')
  • Jython リストを使用:
    AdminTask.editCompUnit(['-blaID', 'myBLA', '–cuID', 'cu1', '–CUOptions', 
      '[[.* .* cu1 cudesc 1 false DEFAULT]]', '-MapTargets', '
      [[.* server2]]', '-ActivationPlanOptions', '[.* #specname=actplan0+specname=actplan2]'])
アセットの構成単位とその関係を編集するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.editCompUnit('-blaID ourBLA – cuID cu4 – CUOptions [[.* .* cu4 "new cu desc" 1 false DEFAULT]]
       –MapTargets [[a1.jar server1+server2]] –RelationshipOptions [[a1.jar cuname=cub true]]')
  • Jython リストを使用:
    AdminTask.editCompUnit(['-blaID', 'ourBLA', '–cuID', 'cu4', '–CUOptions', '
      [[.* .* cu4 "new cu desc" 1 false DEFAULT]]', '–MapTargets', '[[a1.jar server1+server2]]', '–RelationshipOptions', 
      '[[a1.jar cuname=cub true]]'])
既存の関係に新規の関係を追加することによって構成単位を編集するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.editCompUnit('[-blaID ourBLA – cuID cu4 – CUOptions [[.* .* cu4 "new cu desc" 1 false DEFAULT]]
       –MapTargets [[a1.jar server1+server2]] –RelationshipOptions [[a1.jar +cuname=cuc true]] -ActivationPlanOptions 
      [a1.jar +specname=actplan2#specname=actplan1]]')
  • Jython リストを使用:
    AdminTask.editCompUnit(['-blaID', 'ourBLA', '–cuID', 'cu4', '–CUOptions', '
      [[.* .* cu4 "new cu desc" 1 false DEFAULT]]', '–MapTargets', '[[a1.jar server1+server2]]', '–RelationshipOptions',
       '[[a1.jar +cuname=cuc true]]', '-ActivationPlanOptions', '[a1.jar +specname=actplan2#specname=actplan1]'])
エンタープライズ構成単位の構成を編集するには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.editCompUnit('-blaID yourBLA – cuID defaultapp – MapModulesToServers 
      [[defaultapp.war .* WebSphere:cluster=cluster1][Increment.jar .* Websphere:cluster=cluster2]]
       –CtxRootForWebMod [[defaultapp.war .* /]] –MapWebModToVH [[defaultapp.war .* vh1]]')
  • Jython リストを使用:
    AdminTask.editCompUnit(['-blaID', 'yourBLA', '–cuID', 'defaultapp', '–MapModulesToServers', 
     '[[defaultapp.war .* WebSphere:cluster=cluster1][Increment.jar .* Websphere:cluster=cluster2]]', '–CtxRootForWebMod', 
     '[[defaultapp.war .* /]]', '–MapWebModToVH', '[[defaultapp.war .* vh1]]'])

対話モードの使用例

  • Jython の使用:
    AdminTask.editCompUnit('-interactive')

listCompUnits

listCompUnits コマンドは、特定のビジネス・レベル・アプリケーションと関連付けられている各構成単位を表示します。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 (ストリング、必須)

オプション・パラメーター

-includeDescription
コマンドが戻す各アセットの説明を含めるかどうかを指定します。(ストリング、オプション)
-includeType
コマンドが戻す各アセットのタイプを含めるかどうかを指定します。 (ストリング、オプション)

戻り値

以下の例に示すように、このコマンドは構成 ID および各構成単位のタイプのリストを戻します。
Websphere:cuname=cu1
asset
"description for cu1"
Websphere:cuname=cu4
bla
"description for cu4"
WebSphere:cuname=defaultapp
Java EE
"description for defaultapp"

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.listCompUnits('-blaID blaname=theirBLA')
  • Jython リストを使用:
    AdminTask.listCompUnits(['-blaID', 'blaname=theirBLA'])

対話モードの使用例

  • Jython の使用:
    AdminTask.listCompUnits('-interactive')

setCompUnitTargetAutoStart

setCompUnitTargetAutoStart コマンドは、構成単位の自動開始を使用可能または使用不可にします。 このオプションを使用可能にすると、構成単位のターゲットの開始時に、システムによって自動的に構成単位が開始されます。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 不完全な構成 ID でも、システムで固有のビジネス・レベル・アプリケーション ID と一致する場合、このコマンドはその不完全な構成 ID を受け入れます。 (ストリング、必須)
-cuID
対象となる構成単位を指定します。 不完全な構成 ID でも、システムで固有の構成単位 ID と一致する場合、このコマンドはその不完全な構成 ID を受け入れます。 (ストリング、必須)
-targetID
対象となるターゲットの名前を指定します。 例えば、ターゲットを特定のサーバーに設定する場合は、サーバー名を指定します。(ストリング、必須)
-enable
指定のターゲットの開始時に、対象となる構成単位を自動的に開始するかどうかを指定します。 構成単位を自動的に開始する場合は、true を指定します。 true を指定しなかった場合、システムはターゲットの開始時に構成単位を開始しません。 デフォルト値は true です。(ストリング、必須)

戻り値

このコマンドは出力を返しません。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.setCompUnitTargetAutoStart('-blaID bla1 – cuID cu1 – targetID server1 – enable true')
  • Jython リストを使用:
    AdminTask.setCompUnitTargetAutoStart(['-blaID', 'bla1', '–cuID', 'cu1', '–targetID',
       'server1', '–enable', 'true'])

対話モードの使用例

  • Jython ストリングを使用:
    AdminTask.setCompUnitTargetAutoStart('-interactive')

viewCompUnit

viewCompUnit コマンドは、特定のビジネス・レベル・アプリケーションに属する構成単位の構成情報を表示します。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 不完全な構成 ID でも、システムで固有のビジネス・レベル・アプリケーション ID と一致する場合、このパラメーターはその不完全な構成 ID を受け入れます。(ストリング、必須)
-cuID
対象となる構成単位の構成 ID を指定します。 不完全な構成 ID でも、システムで固有の構成単位 ID と一致する場合、このパラメーターはその不完全な構成 ID を受け入れます。(ストリング、必須)

オプション・パラメーター

なし

戻り値

以下の例に示すように、このコマンドは対象となる構成単位の構成情報を戻します。
Specify Composition Unit options (CUOptions)

Specify name, description options for Composition Unit.

Parent BLA (parentBLA): [WebSphere:blaname=myBLA]
Backing Id (backingId): [WebSphere:assetname=asset1.zip]
Name (name): [cu1]
Description (description): [cuDesc]
Starting Weight (startingWeight): [0]
Started on distributed (startedOnDistributed): [false]
Restart behavior on update (restartBehaviorOnUpdate): [DEFAULT]

Specify servers (MapTargets)

Specify targets such as application servers or clusters of application servers where you want to deploy the cu contained in the application.

Deployable Unit (deplUnit): [default]
*Servers (server): [WebSphere:node=myNode,server=server1]

Specify Composition Unit activation plan options (ActivationPlanOptions)

Specify CU activation plan optionsDeployableUnit Name (deplUnit): [default]
Activation Plan (activationPlan): [WebSphere:specname=actplan0+WebSphere:specname=actplan1] 
構成単位 に Enterprise Bundle Archive (EBA) アセットが含まれている場合、 構成単位状況も表示されます。この状況の値は、以下のいずれかです。
  • 最新の OSGi アプリケーション・デプロイメントを使用しています。
  • 新規の OSGi アプリケーション・デプロイメントは、現在ダウンロード中のバンドルを必要とするため、使用可能になっていません。
  • 新規の OSGi アプリケーション・デプロイメントが使用可能です。
  • バンドル・ダウンロードが失敗したため、新規の OSGi アプリケーション・デプロイメントを適用できません。

バッチ・モードの使用例

以下は、非エンタープライズ・アセットの構成情報を表示する場合の例です。
  • Jython ストリングを使用:
    AdminTask.viewCompUnit('-blaID myBLA -cuID myCompUnit')
  • Jython リストを使用:
    AdminTask.viewCompUnit(['-blaID', 'myBLA', '-cuID', 'myCompUnit'])
以下は、エンタープライズ・アセットの構成情報を表示する場合の例です。
  • Jython ストリングを使用:
    AdminTask.viewCompUnit('-blaID myBLA -cuID defaultApplication')
  • Jython リストを使用:
    AdminTask.viewCompUnit(['-blaID', 'myBLA', '-cuID', 'defaultApplication'])

対話モードの使用例

  • Jython の使用:
    AdminTask.viewCompUnit('-interactive')

createEmptyBLA

createEmptyBLA コマンドは、空のビジネス・レベル・アプリケーションを作成します。 ビジネス・レベル・アプリケーションの作成後には、そのアプリケーションにアセットまたは他のビジネス・レベル・アプリケーションを構成単位として追加できます。

ターゲット・オブジェクト

なし

必須パラメーター

-name
新規ビジネス・レベル・アプリケーションの固有名を指定します。(ストリング、必須)

オプション・パラメーター

-description
新規ビジネス・レベル・アプリケーションの説明を指定します。(ストリング、オプション)

戻り値

以下の例に示すように、このコマンドは新規ビジネス・レベル・アプリケーションの構成 ID を戻します。
WebSphere:blaname=myBLA

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.createEmptyBLA('-name myBLA -description "my description for BLA"')
  • Jython リストを使用:
    AdminTask.createEmptyBLA(['-name', 'myBLA', '-description', '"my description for BLA"'])

対話モードの使用例

  • Jython の使用:
    AdminTask.createEmptyBLA('-interactive')

deleteBLA

deleteBLA コマンドは、ビジネス・レベル・アプリケーションを構成から除去します。 ビジネス・レベル・アプリケーションを削除する前に、deleteCompUnit コマンドを使用して、ビジネス・レベル・アプリケーションに関連付けられている各構成単位を除去します。 また、削除するビジネス・レベル・アプリケーションを参照する他のビジネス・レベル・アプリケーションがないことを確認してください。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 不完全な ID のストリングでも、システムが固有の ID に一致させることができる限り、このコマンドは blaID パラメーターに対するその不完全な ID を受け入れます。 例えば、myBLA という部分的な ID を指定して、WebSphere:blaname=myBLA 構成 ID を指定することができます。(ストリング、必須)

オプション・パラメーター

なし

戻り値

以下の例に示すように、このコマンドは削除されるビジネス・レベル・アプリケーションの構成 ID を戻します。
WebSphere:blaname=myBLA

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.deleteBLA('-blaID myBLA')
  • Jython リストを使用:
    AdminTask.deleteBLA(['-blaID', 'myBLA'])

対話モードの使用例

  • Jython の使用:
    AdminTask.deleteBLA('-interactive')

editBLA

editBLA コマンドは、ビジネス・レベル・アプリケーションの説明を変更します。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 (ストリング、必須)

オプションのステップ

オプションのステップでは、.* の文字を使用して、 読み取り専用の引数をコマンドの構文に指定します。"" の文字を使用して空ストリングを指定し、 引数の既存の値を保持します。 書き込み可能な引数に値または空ストリングを指定しない場合、コマンドによって引数が ヌル値にリセットされます。
-BLAOptions
対象となるビジネス・レベル・アプリケーションの新規の説明を指定するには、BLAOptions ステップを使用します。
name (読み取り専用)
ビジネス・レベル・アプリケーションの名前を指定します。
description
ビジネス・レベル・アプリケーションの説明を指定します。

戻り値

このコマンドは出力を返しません。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.editBLA('-blaID DefaultApplication – BLAOptions [[.* "my new description"]]')
  • Jython リストを使用:
    AdminTask.editBLA(['-blaID', 'DefaultApplication', '–BLAOptions', '[[.* "my new description"]]'])

対話モードの使用例

  • Jython の使用:
    AdminTask.editBLA('-interactive')

getBLAStatus

getBLAStatus コマンドは、ビジネス・レベル・アプリケーションまたは構成単位が実行状態にあるか停止状態にあるかを表示します。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 ビジネス・レベル・アプリケーションの構成 ID のリストを表示するには、listBLAs コマンドを使用します。(ストリング、必須)

オプション・パラメーター

-cuID
対象となる構成単位の構成 ID を指定します。 構成単位の構成 ID のリストを表示するには、listCompUnits コマンドを使用します。(ストリング、オプション)

戻り値

このコマンドは、対象となるビジネス・レベル・アプリケーションまたは構成単位の状況を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.getBLAStatus('-blaID WebSphere:blaname=myBLA -cuID Websphere:cuname=cu1')
  • Jython リストを使用:
    AdminTask.getBLAStatus(['-blaID', 'WebSphere:blaname=myBLA', '-cuID', 'Websphere:cuname=cu1'])

対話モードの使用例

  • Jython の使用:
    AdminTask.getBLAStatus('-interactive')

listBLAs

listBLAs コマンドは、構成内にあるビジネス・レベル・アプリケーションを表示します。

ターゲット・オブジェクト

なし

オプション・パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 (ストリング、オプション)
-includeDescription
コマンドが戻す各ビジネス・レベル・アプリケーションの説明を含めるかどうかを指定します。ビジネス・レベル・アプリケーションの説明を表示する場合は、true を指定します。(ストリング、オプション)

戻り値

以下の例に示すように、このコマンドは構成内にある各ビジネス・レベル・アプリケーションの構成 ID のリストを戻します。
WebSphere:blaname=myBLAWebSphere:blaname=yourBLA

バッチ・モードの使用例

以下は、構成内にある各ビジネス・レベル・アプリケーションをリストする場合の例です。
  • Jython の使用:
    AdminTask.listBLAs()
構成内にある各ビジネス・レベル・アプリケーションをリストするには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.listBLAs('-blaID myBLA')
  • Jython リストを使用:
    AdminTask.listBLAs(['-blaID', 'myBLA'])
各ビジネス・レベル・アプリケーションとそれに対応する説明をリストするには、以下の例を参考にしてください。
  • Jython ストリングを使用:
    AdminTask.listBLAs('-includeDescription true')
  • Jython リストを使用:
    AdminTask.listBLAs(['-includeDescription', 'true'])

対話モードの使用例

  • Jython ストリングを使用:
    AdminTask.listBLAs('-interactive')

listControlOps

listControlOps コマンドは、ビジネス・レベル・アプリケーションとその対応する構成単位の制御オペレーションを表示します。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 (ストリング、必須)

オプション・パラメーター

-cuID
対象となる構成単位を指定します。 (ストリング、オプション)
-opName
対象となるオペレーション名を指定します。(ストリング、オプション)
-long
コマンドの出力に追加の構成情報を含めるかどうかを指定します。(ストリング、オプション)

戻り値

以下の例に示すように、このコマンドは、照会の範囲内にあるオペレーション、オペレーションの説明、およびパラメーターの説明のリストを戻します。
"Operation: start"
   "Description: Start operation"
   "Operation handler ID: com.mycompany.myasset.ControlOpHandler" 
   "Operation handler data URI: None"
"Operation: stop"
   "Description: Stop operation"
   "Operation handler ID: com.mycompany.myasset.ControlOpHandler"
   "Operation handler data URI: None"
"Operation: clearCache"
   "Description: Clears specified cache or all caches"
   "Operation handler ID: com.mycompany.myasset.ControlOpHandler"
   "Operation handler data URI: None"
   "Parameter: cacheName"
      "Description: Name of cache to clear.  If not specified, all caches are cleared."

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.listControlOps('-blaID myBLA – cuID myservice.jar – long true')
  • Jython リストを使用:
    AdminTask.listControlOps(['-blaID', 'myBLA', '–cuID', 'myservice.jar', '–long true'])

対話モードの使用例

  • Jython の使用:
    AdminTask.listControlOps('-interactive')

startBLA

startBLA コマンドは、対象となるビジネス・レベル・アプリケーションを開始します。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
開始するビジネス・レベル・アプリケーションの構成 ID を指定します。 不完全な構成 ID のストリングでも、システムで構成内の固有の ID と一致する場合、このコマンドはその不完全な構成 ID を受け入れます。(ストリング、必須)

戻り値

ビジネス・レベル・アプリケーションが開始された場合、このコマンドは状況メッセージを戻します。 ビジネス・レベル・アプリケーションが開始されなかった場合、このコマンドは出力を戻しません。 以下は、状況メッセージ出力が表示される場合の例です。
BLA ID of started BLA if the BLA was not already running. 

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.startBLA('-blaID myBLA')
  • Jython リストを使用:
    AdminTask.startBLA(['-blaID', 'myBLA'])

対話モードの使用例

  • Jython の使用:
    AdminTask.startBLA('-interactive')

stopBLA

stopBLA コマンドは、対象となるビジネス・レベル・アプリケーションを停止します。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
停止するビジネス・レベル・アプリケーションの構成 ID を指定します。 不完全な構成 ID のストリングでも、システムで構成内の固有の ID と一致する場合、このコマンドはその不完全な構成 ID を受け入れます。(ストリング、必須)

戻り値

ビジネス・レベル・アプリケーションが停止された場合、このコマンドは状況メッセージを戻します。 ビジネス・レベル・アプリケーションが停止されなかった場合、このコマンドは出力を戻しません。 以下は、状況メッセージ出力が表示される場合の例です。
BLA ID of stopped BLA if the BLA was not already stopped. 

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.stopBLA('-blaID myBLA')
  • Jython リストを使用:
    AdminTask.stopBLA(['-blaID', 'myBLA'])

対話モードの使用例

  • Jython の使用:
    AdminTask.stopBLA('-interactive')

viewBLA

viewBLA コマンドは、対象となるビジネス・レベル・アプリケーションの名前および説明を表示します。

ターゲット・オブジェクト

なし

必須パラメーター

-blaID
対象となるビジネス・レベル・アプリケーションの構成 ID を指定します。 不完全な構成 ID のストリングでも、システムでビジネス・レベル・アプリケーションと一致する場合、このコマンドはその不完全な構成 ID を受け入れます。(ストリング、必須)

オプション・パラメーター

なし

戻り値

以下の例に示すように、このコマンドは対象となるビジネス・レベル・アプリケーションの構成情報を戻します。
Specify BLA options (BLAOptions)

Specify options for BLA

*BLA Name (name): [DefaultApplication]
BLA Description (description): []

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.viewBLA('-blaID DefaultApplication')
  • Jython リストを使用:
    AdminTask.viewBLA(['-blaID', 'DefaultApplication'])

対話モードの使用例

  • Jython の使用:
    AdminTask.viewBLA('-interactive')

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



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