AdminTask オブジェクトの dpManagerCommands コマンド・グループ

Jython スクリプト言語を使用すると、wsadmin ツールで DataPower® アプライアンス・マネージャーを構成することができます。 IBM WebSphere® DataPower アプライアンス・マネージャーは、DataPower アプライアンスを管理するための一連の機能を備えています。 DataPower アプライアンス・マネージャーの照会、構成、および管理を行うには、dpManagerCommands グループのコマンドおよびパラメーターを使用します。

IBM® WebSphere® DataPower SOA アプライアンスは、XML および Web サービスのデプロイメントを迅速化、セキュア化、および単純化する、デプロイが容易な専用ネットワーク・デバイスです。初めて DataPower アプライアンス・マネージャーを使用する場合、アプライアンス、管理対象セット、またはファームウェア・バージョンは存在していません。 アプライアンスの作成、ファームウェア・バージョンの追加、および管理対象セットの作成を行う必要があります。

作業を開始する前に、管理の対象となる各アプライアンスのファームウェアのレベルが 3.6.0.4 以上になっていることを確認してください。 また、各アプライアンスで Appliance Management Protocol (AMP) エンドポイントが使用可能になっていることを確認してください。 インストール時に XML 管理インターフェースの AMP エンドポイントを使用不可にした場合は、DataPower WebGUI を使用して AMP エンドポイントを使用可能にします。

注: DataPower Web GUI は、管理コンソールの DataPower アプライアンス・マネージャーとは異なります。
DataPower アプライアンス・マネージャーの管理には、以下のコマンドを使用します。
管理対象セットの管理には、以下のコマンドを使用します。
設定および設定のバージョンの管理には、以下のコマンドを使用します。
タスクの管理には、以下のコマンドを使用します。

dpExport

dpExport コマンドは、DataPower アプライアンス・マネージャーの構成およびバージョンをエクスポートします。

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

なし。

必須パラメーター

-file
DataPower アプライアンス・マネージャーが構成およびバージョンをエクスポートする際の宛先とするローカル・システム・ファイルを指定します。(ストリング、必須)

戻り値

このコマンドは、システムが作成するタスクの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    [Windows]
    AdminTask.dpExport('-file c:/temp/DPManager.export_doc') 
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpExport('-file 
     /temp/DPManager.export')
  • Jython リストを使用:
    [Windows]
    AdminTask.dpExport(['-file', 'C:/temp/DPManager.export'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpExport(['-file', 
     '/temp/DPManager.export'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpExport('-interactive')

dpGetManager

dpGetManager コマンドは、DataPower アプライアンス・マネージャーのプロパティーを表示します。

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

なし。

戻り値

このコマンドは、DataPower アプライアンス・マネージャーの現行設定が含まれたプロパティー・オブジェクトを戻します。

バッチ・モードの使用例

  • Jython ストリングおよびリストを使用:
    AdminTask.dpGetManager()

dpGetManagerStatus

dpGetManagerStatus コマンドは、DataPower アプライアンス・マネージャーの状況を表示します。

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

なし。

戻り値

このコマンドは、DataPower アプライアンス・マネージャーの状況の説明を戻します。

バッチ・モードの使用例

  • Jython ストリングおよびリストを使用:
    AdminTask.dpGetManagerStatus()

dpImport

dpImport コマンドは、DataPower アプライアンス・マネージャーの構成およびバージョンをインポートします。 このコマンドは、既存の構成およびバージョンを、インポートされた構成およびバージョンで置き換えます。

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

なし。

必須パラメーター

-file
インポートする構成およびバージョンが含まれた DataPower アプライアンス・マネージャー・システム・ファイルを指定します。(ストリング、必須)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    [Windows]
    AdminTask.dpImport('-file c:/temp/DPManager.import')
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpImport('-file 
     /temp/DPManager.import')
  • Jython リストを使用:
    [Windows]
    AdminTask.dpImport(['-file', 'C:/temp/DPManager.export'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpImport(['-file', 
     '/temp/DPManager.export'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpImport('-interactive')

dpSetManager

dpSetManager コマンドは、DataPower アプライアンス・マネージャーの構成を変更します。

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

なし。

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

-maxVersionsToStore
バージョンの新規の最大保持数を指定します。(整数、オプション)
-versionsDirectory
DataPower アプライアンス・マネージャーがバージョンの作成先とする、そのマネージャーのシステム・ディレクトリーを指定します。 このコマンドは、既存のバージョンを現行のバージョン・ディレクトリーから新規のバージョン・ディレクトリーに移動します。(ストリング、オプション)

戻り値

versionsDirectory パラメーターに値を指定した場合、このコマンドによって作成されるタスクの ID が戻されます。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSetManager('-maxVersionsToStore 20 -versionsDirectory newDir')
  • Jython リストを使用:
    AdminTask.dpSetManager(['-maxVersionsToStore', '20', '-versionsDirectory', 'newDir'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSetManager('-interactive')

dpStopManager

dpStopManager コマンドは、DataPower アプライアンス・マネージャーを停止します。 DataPower アプライアンス・マネージャーは、次に使用される際に自動的に再始動します。

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

なし。

戻り値

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

バッチ・モードの使用例

  • Jython ストリングおよびリストを使用:
    AdminTask.dpStopManager()

dpAddAppliance

dpAddAppliance コマンドは、DataPower アプライアンス・マネージャーにアプライアンスを追加します。

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

なし。

必須パラメーター

-hostname
アプライアンスのホスト名または IP アドレスを指定します。(ストリング、必須)
-hlmPort
DataPower アプライアンス・マネージャーがアプライアンスと通信するために使用するポート番号を指定します。 デフォルト値は 5550 です。(整数、必須)
-name
DataPower アプライアンス・マネージャー内でのアプライアンスの固有名を指定します。 この name パラメーターには、¥¥/,#$@:;¥"*?<>|=+&%' の文字を指定しないでください。(ストリング、必須)
-userId
DataPower アプライアンス・マネージャーがアプライアンスにアクセスするために使用するユーザー ID を指定します。(ストリング、必須)
-password
DataPower アプライアンス・マネージャーがアプライアンスにアクセスするために使用する Base64 でエンコードされたパスワードを指定します。(ストリング、必須)

戻り値

このコマンドは、システムが作成するタスクの ID を戻します。 このタスクの終了時、このタスクの結果属性の値には新規アプライアンスの ID が入っています。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpAddAppliance('[-hostname myappliance.ibm.com – name myappliance -userId 
     admin -password mypassword]')
  • Jython リストを使用:
    AdminTask.dpAddAppliance(['-hostname', 'myappliance.ibm.com', '–name', 'myappliance', '-userId', '
      admin', '-password', 'mypassword'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpAddAppliance('-interactive')

dpGetAllApplianceIds

dpGetAllApplianceIds コマンドは、DataPower アプライアンス・マネージャーの各アプライアンスの ID を表示します。

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

なし。

戻り値

このコマンドは、構成内の各アプライアンスの ID を含んだストリング配列を戻します。 各アプライアンスの ID は、DataPower アプライアンスのシリアル番号です。

バッチ・モードの使用例

  • Jython ストリングおよびリストを使用:
    AdminTask.dpGetAllApplianceIds()

dpGetAllMSApplianceIds

dpGetAllMSApplianceIds コマンドは、DataPower アプライアンス・マネージャーの管理対象セット内の各アプライアンスの ID を表示します。

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

なし。

必須パラメーター

-managedSetId
対象となる管理対象セットの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、対象となる管理対象セット内のアプライアンスの ID を含んだストリング配列を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetAllMSApplianceIds('[-managedSetId myManagedSet]')
  • Jython リストを使用:
    AdminTask.dpGetAllMSApplianceIds(['-managedSetId', 'myManagedSet'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetAllMSApplianceIds('-interactive')

dpGetAppliance

dpGetAppliance コマンドは、DataPower アプライアンス・マネージャーの特定のアプライアンスを表示します。

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

なし。

必須パラメーター

-applianceId
DataPower アプライアンス・マネージャー内の、表示するアプライアンスの ID を指定します。(ストリング、必須)

戻り値

以下の出力例に示すように、このコマンドは対象となるアプライアンスの属性が含まれたプロパティー・オブジェクトを戻します。
[ [userId admin] [applianceType XI50] [serialNumber [00605 20356]] 
 [firmwareManagementStatus ManagementStatus.synced] [actualFirmwareLevel 3.6.1.0] [rollupOperationalStatus 
 OperationalStatus.unknown] [hostname dp3.dyn.webahead.ibm.com] [settingsManagementStatus ManagementStatus.synced] 
 [rollupManagementStatus ManagementStatus.synced] [applianceId [00605 20356]] [guiPort 8080] [modelType 9002] [isManaged true] 
 [managedSetId jgMS1] [featureLicenses [MQ, TAM, DataGlue, JAXP-API, PKCS7-SMIME, WebSphere-JMS]] [hlmPort 5550] [isMaster true] 
 [name dp3] ]
表 1. コマンド属性. 以下の表は、このコマンドが戻す各属性について説明したものです。
属性 説明
applianceId 対象となるアプライアンスの ID を表示します。
managedSetId そのアプライアンスがメンバーとして属す管理対象セットの ID を表示します。 そのアプライアンスが管理の対象になっていない場合、コマンドはこの属性を戻しません。
actualFirmwareLevel そのアプライアンスのファームウェアのレベルを表示します。
featureLicenses そのアプライアンスのフィーチャー・ライセンス (MQTAM など) のリストを表示します。
guiPort DataPower WebGUI インターフェースのアプライアンス・ポートを表示します。
hlmPort DataPower アプライアンス・マネージャーとアプライアンスの間の通信用ポート番号を表示します。
hostname そのアプライアンスのホスト名またはインターネット・プロトコル (IP) アドレスを表示します。
isManaged DataPower アプライアンス・マネージャーがそのアプライアンスを管理している場合、値 true を表示します。
isMaster そのアプライアンスが管理対象セット内のマスター・アプライアンスである場合、値 true を表示します。 そのアプライアンスが DataPower アプライアンス・マネージャーによって管理されていない場合、このプロパティーは表示されません。
modelType そのアプライアンスのモデル・タイプを表示します。
applianceType そのアプライアンスのタイプを表示します。
settingsManagementStatus そのアプライアンスの設定の管理状況を表示します。 この属性は、DataPower WebGUI では同期状況とも呼ばれます。
firmwareManagementStatus そのアプライアンスのファームウェアの管理状況を表示します。 この属性は、DataPower WebGUI では同期状況とも呼ばれます。
domainManagementStatus そのアプライアンスの特定ドメインの管理状況を表示します。 この属性は、DataPower WebGUI では同期状況とも呼ばれます。
domainOperationalStatus そのアプライアンスの特定ドメインの運用状況を表示します。
rollupManagementStatus そのアプライアンスのファームウェア、設定、およびドメインの集約管理状況を表示します。 この属性は、DataPower WebGUI では同期状況とも呼ばれます。
rollupOperationalStatus そのアプライアンスのファームウェア、設定、およびドメインの集約運用状況を表示します。
serialNumber 対象となるアプライアンスのシリアル番号を表示します。
name DataPower アプライアンス・マネージャー内のアプライアンスの名前を表示します。
userId DataPower アプライアンス・マネージャーがアプライアンスにアクセスするために使用するユーザー ID を表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetAppliance('-applianceId "00605 20356"')
  • Jython リストを使用:
    AdminTask.dpGetAppliance(['-applianceId', '00605 20356']) 

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetAppliance('-interactive')

dpManageAppliance

dpManageAppliance コマンドは、管理対象セットにアプライアンスを追加し、アプライアンスの管理を開始します。

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

なし。

必須パラメーター

-managedSetId
そのアプライアンスがメンバーとして属す管理対象セットの ID を指定します。 (ストリング、必須)
-applianceId
DataPower アプライアンス・マネージャー内の、管理対象セットに追加するアプライアンスの ID を指定します。(ストリング、必須)

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

-asMaster
そのアプライアンスを管理対象セットのマスター・アプライアンスとして設定するかどうかを指定します。 管理対象セットに追加された最初のアプライアンスは、このパラメーターが指定されていなくてもマスター・アプライアンスとして設定されます。(ストリング、オプション)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。 このタスクの完了時、結果属性の値はアプライアンスの ID となります。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpManageAppliance('-managedSetId testMS1 -applianceId "00605 20351"')
  • Jython リストを使用:
    AdminTask.dpManageAppliance(['-managedSetId', 'testMS1', '-applianceId', '00605 20351'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpManageAppliance('-interactive')

dpRemoveAppliance

dpRemoveAppliance コマンドは、DataPower アプライアンス・マネージャーからアプライアンスを除去します。 また、このコマンドは管理対象セットからもアプライアンスを除去します (そのアプライアンスがメンバーである場合)。 管理対象セットのマスター・アプライアンスは除去できません。 マスター・アプライアンスを除去するには、事前に別のアプライアンスをマスターとして選択する必要があります。

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

なし。

必須パラメーター

-applianceId
DataPower アプライアンス・マネージャー内の、管理対象セットから除去するアプライアンスの ID を指定します。 各アプライアンスの ID は、DataPower アプライアンスのシリアル番号です。 (ストリング、必須)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpRemoveAppliance('[-applianceId "00605 20356"]')
  • Jython リストを使用:
    AdminTask.dpRemoveAppliance(['-applianceId', '00605 20356'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpRemoveAppliance('-interactive')

dpSetAppliance

dpSetAppliance コマンドは、DataPower アプライアンス・マネージャーのアプライアンス用構成を変更します。

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

なし。

必須パラメーター

-applianceId
DataPower アプライアンス・マネージャー内の、変更するアプライアンスの ID を指定します。(ストリング、必須)

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

-hostname
アプライアンスのホスト名または IP アドレスを指定します。(ストリング、オプション)
-hlmPort
DataPower アプライアンス・マネージャーがアプライアンスと通信するために使用するポート番号を指定します。 デフォルト値は 5550 です。(整数、オプション)
-name
DataPower アプライアンス・マネージャー内でのアプライアンスの固有名を指定します。 この name パラメーターには、¥¥/,#$@:;¥"*?<>|=+&%' の文字を指定しないでください。(ストリング、オプション)
-userId
DataPower アプライアンス・マネージャーがアプライアンスにアクセスするために使用するユーザー ID を指定します。(ストリング、オプション)
-password
DataPower アプライアンス・マネージャーがアプライアンスにアクセスするために使用する Base64 でエンコードされたパスワードを指定します。(ストリング、オプション)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSetAppliance('[-applianceId "00605 20356" -hostname myappliance2.ibm.com 
     -name myappliance2 -hlmPort 4500 -userId admin2 -password myPassword]')
  • Jython リストを使用:
    AdminTask.dpSetAppliance(['-applianceId', '00605 20356', '-hostname', 
     'myappliance2.ibm.com', '-name', 'myappliance2', '-hlmPort', '4500', '-userId', 'admin2', 
     '-password', 'myPassword']) 

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSetAppliance('-interactive')

dpUnmanageAppliance

dpUnmanageAppliance コマンドは、対象となるアプライアンスを、その管理対象セットから除去します。 そのアプライアンスは管理の対象からは外れますが、マネージャーに対しては定義されたままになります。

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

なし。

必須パラメーター

-managedSetId
そのアプライアンスがメンバーとして属す管理対象セットの ID を指定します。 (ストリング、必須)
-applianceId
DataPower アプライアンス・マネージャー内の、管理対象セットから除去するアプライアンスの ID を指定します。 (ストリング、必須)

戻り値

このコマンドは、このコマンドによって作成されたタスクを戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpUnmanageAppliance('[-managedSetId testMS1 -applianceId "00605 
     20351"]')
  • Jython リストを使用:
    AdminTask.dpUnmanageAppliance(['-managedSetId', 'testMS1', '-applianceId "00605 20351"'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpUnmanageAppliance('-interactive')

dpAddManagedSet

dpAddManagedSet コマンドは、DataPower アプライアンス・マネージャーに管理対象セットを追加します。

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

なし。

必須パラメーター

-name
DataPower アプライアンス・マネージャー内でのアプライアンスの固有名を指定します。 この name パラメーターには、¥¥/,#$@:;¥"*?<>|=+&%' の文字を指定しないでください。(ストリング、必須)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpAddManagedSet('-name testMS')
  • Jython リストを使用:
    AdminTask.dpAddManagedSet(['-name testMS'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpAddManagedSet('-interactive')

dpGetAllManagedSetIds

dpGetAllManagedSetIds コマンドは、DataPower アプライアンス・マネージャーの各管理対象セットの ID を表示します。

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

なし。

戻り値

このコマンドは、各管理対象セットの ID を含んだストリング配列を戻します。

バッチ・モードの使用例

  • Jython ストリングおよびリストを使用:
    AdminTask.dpGetAllManagedSetIds()

dpGetManagedSet

dpGetManagedSet コマンドは、DataPower アプライアンス・マネージャーの特定の管理対象セットに関する情報を表示します。

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

なし。

必須パラメーター

-managedSetId
対象となる管理対象セットの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、管理対象セットの属性が含まれたプロパティー・オブジェクトを戻します。
表 2. コマンド属性. 以下の表は、このコマンドが戻す属性についての追加情報を示したものです。
属性 説明
managedSetId その管理対象セットの ID を表示します。
masterApplianceId その管理対象セットのマスター・アプライアンスの ID を表示します。
desiredFirmwareVersionId その管理対象セットで使用するファームウェア・バージョンの ID を表示します。
name その管理対象セットに関連付けられている名前を表示します。
rollupOperationalStatus その管理対象セットの運用状況を表示します。
rollupManagementStatus その管理対象セットの管理状況を表示します。
settingsId その管理対象セットの設定の ID を表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetManagedSet('-managedSetId testMS1')
  • Jython リストを使用:
    AdminTask.dpGetManagedSet(['-managedSetId', 'testMS1']) 

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetManagedSet('-interactive')

dpRemoveManagedSet

dpRemoveManagedSet コマンドは、DataPower アプライアンス・マネージャーから管理対象セットを除去します。

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

なし。

必須パラメーター

-managedSetId
除去する管理対象セットの ID を指定します。(ストリング、必須)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpRemoveManagedSet('-managedSetId  testMS')
  • Jython リストを使用:
    AdminTask.dpRemoveManagedSet(['-managedSetId', 'testMS'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpRemoveManagedSet('-interactive')

dpSetManagedSet

dpSetManagedSet コマンドは、DataPower アプライアンス・マネージャーの管理対象セットを変更します。

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

なし。

必須パラメーター

-managedSetId
変更する管理対象セットの ID を指定します。(ストリング、必須)

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

-masterApplianceId
管理対象セットのマスター・アプライアンスとして設定するアプライアンスの ID を指定します。 このアプライアンスは、その管理対象セットのメンバーにしておく必要があります。 このパラメーターは、desiredFirmwareVersionId パラメーターと相互排他の関係にあります。(ストリング、オプション)
-desiredFirmwareVersionId
管理対象セット内の各アプライアンスに同期させるファームウェア・バージョンの ID を指定します。 このパラメーターは、masterApplianceId パラメーターと相互排他の関係にあります。(ストリング、オプション)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSetManagedSet('-managedSetId myManagedSet -masterApplianceId "00605 
     20356"')
  • Jython リストを使用:
    AdminTask.dpSetManagedSet(['-managedSetId', 'myManagedSet', '-masterApplianceId', '"00605 20356"'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSetManagedSet('-interactive')

dpSynchManagedSet

dpSynchManagedSet コマンドは、DataPower アプライアンス・マネージャーの管理対象セットの手動同期を行います。 マネージャーは自動的にメンバー・デバイスを同期させようとします。

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

なし。

必須パラメーター

-managedSetId
同期させる管理対象セットの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSynchManagedSet('-managedSetId myManagedSet')
  • Jython リストを使用:
    AdminTask.dpSynchManagedSet(['-managedSetId', 'myManagedSet'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSynchManagedSet('-interactive')

dpAddFirmwareVersion

dpAddFirmwareVersion コマンドは、DataPower アプライアンス・マネージャーにファームウェア・バージョンを追加します。

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

なし。

必須パラメーター

-file
ファームウェア・バージョンに保管するファームウェア・イメージが含まれた、DataPower アプライアンス・マネージャー・ファイル・システム内のファイルを指定します。(ストリング、必須)

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

-userComment
ファームウェア・バージョンに保管するコメントを指定します。(ストリング、オプション)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。 このタスクの終了時、結果属性の値には、新規ファームウェア・バージョンの ID が表示されます。

バッチ・モードの使用例

  • Jython ストリングを使用:
    [Windows]
    AdminTask.dpAddFirmwareVersion('[-file 
     "C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpAddFirmwareVersion('[-file 
     "/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
  • Jython リストを使用:
    [Windows]
    AdminTask.dpAddFirmwareVersion(['-file', 
     '"C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpAddFirmwareVersion(['-file', 
     '"/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpAddFirmwareVersion('-interactive')

dpGetAllFirmwareIds

dpGetAllFirmwareIds コマンドは、DataPower アプライアンス・マネージャーの、構成内にある各ファームウェアの ID を表示します。

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

なし。

戻り値

このコマンドは、DataPower アプライアンス・マネージャーの構成内にある各ファームウェアの ID のストリング配列を戻します。

バッチ・モードの使用例

  • Jython ストリングおよびリストを使用:
    AdminTask.dpGetAllFirmwareIds()

dpGetAllFirmwareVersionIds

dpGetAllFirmwareVersionIds コマンドは、DataPower アプライアンス・マネージャーの各ファームウェア・バージョンの ID を表示します。 ファームウェア・バージョンは、DataPower アプライアンスにデプロイ可能なファームウェア・イメージを表します。

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

なし。

必須パラメーター

-firmwareId
照会するファームウェアの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、構成内の各ファームウェア・バージョンを含んだストリング配列を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetAllFirmwareVersionIds('-firmwareId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
  • Jython リストを使用:
    AdminTask.dpGetAllFirmwareVersionIds(['-firmwareId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetAllFirmwareVersionIds('-interactive')

dpGetAllMSIdsUsingFirmwareVersion

dpGetAllMSIdsUsingFirmwareVersion コマンドは、ファームウェア・バージョンを使用する管理対象セットの ID を表示します。

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

なし。

必須パラメーター

-firmwareVersionId
対象となるファームウェア・バージョンの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、対象となるファームウェア・バージョンを使用する管理対象セットの ID を含んだストリング配列を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Jython リストを使用:
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-interactive')

dpGetBestFirmware

dpGetBestFirmware コマンドは、パラメーターに最もよく合致する DataPower アプライアンス・マネージャー内のファームウェアを表示します。 DataPower アプライアンス・マネージャー内のファームウェアには、そのファームウェアの各種バージョンを表す 1 つ以上のファームウェア・バージョンが含まれています。 このコマンドは、DataPower の最適のファームウェア・リリースを識別するものではありません。 このコマンドは、そのアプライアンスに合致するファームウェア・バージョンを識別します。

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

なし。

必須パラメーター

-applianceType
ファームウェアが表示される DataPower アプライアンスのアプライアンス・タイプを指定します。(ストリング、必須)
-modelType
ファームウェアが表示される DataPower アプライアンスのモデル・タイプを指定します。(ストリング、必須)
-applianceFeatures
ファームウェアが表示される DataPower アプライアンスのアプライアンス・フィーチャーを指定します。(ストリング、必須)

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

-level
戻されるファームウェアに含めるファームウェア・バージョンのレベルを指定します。(ストリング、オプション)

戻り値

このコマンドは、ファームウェアの属性が含まれたプロパティー・オブジェクトを戻します。
表 3. コマンド属性. 以下の表は、このコマンドが戻す属性について説明したものです。
属性 説明
firmwareId そのファームウェアの ID を表示します。
applianceType そのファームウェアの使用対象となるアプライアンス・タイプを表示します。
modelType そのファームウェアのモデル・タイプを表示します。
strictFeatures そのファームウェアの使用対象となる厳密なフィーチャーを表示します。
nonStrictFeatures そのファームウェアの使用対象となる厳密でないフィーチャーを表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetBestFirmware('-applianceType "XS40" -modelType "9002" 
     -applianceFeatures "JAXP-API" -level "3.6.0.4"')
  • Jython リストを使用:
    AdminTask.dpGetBestFirmware(['-applianceType', 'XS40', '-modelType', '9002', 
     '-applianceFeatures', 'JAXP-API', '-level', '3.6.0.4'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetBestFirmware('-interactive')

dpGetFirmware

dpGetFirmware コマンドは、DataPower アプライアンス・マネージャーの特定のファームウェアの属性を表示します。

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

なし。

必須パラメーター

-firmwareId
対象となるファームウェアの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、対象となるファームウェアの属性が含まれたプロパティー・オブジェクトを戻します。
表 4. コマンド属性. 以下の表は、このコマンドが戻す属性について説明したものです。
属性 説明
firmwareId そのファームウェアの ID を表示します。
applianceType そのファームウェアの使用対象となるアプライアンス・タイプを表示します。
modelType そのファームウェアのモデル・タイプを表示します。
strictFeatures そのファームウェアの使用対象となる厳密なフィーチャーを表示します。
nonStrictFeatures そのファームウェアの使用対象となる厳密でないフィーチャーを表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetFirmware('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
  • Jython リストを使用:
    AdminTask.dpGetFirmware(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetFirmware('-interactive')

dpGetFirmwareVersion

dpGetFirmwareVersion コマンドは、DataPower アプライアンス・マネージャーの特定のファームウェア・バージョンを表示します。 ファームウェア・バージョンは、DataPower アプライアンスにデプロイ可能なファームウェア・イメージを表します。

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

なし。

必須パラメーター

-firmwareVersionId
対象となるファームウェア・バージョンの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、ファームウェア・バージョンの属性が含まれたプロパティー・オブジェクトを戻します。
表 5. コマンド属性. 以下の表は、このコマンドが戻す各属性についての追加情報を示したものです。
属性 説明
firmwareVersionId そのファームウェア・バージョンの ID を表示します。
firmareId そのファームウェア・バージョンが含まれているファームウェアの ID を表示します。
level そのファームウェアのレベルを表示します。
manufactureDate そのファームウェアが製造された日付を表示します。
timestamp そのファームウェア・イメージが DataPower アプライアンス・マネージャーにロードされた日付を表示します。
userComment そのファームウェア・バージョンとともに保管されたコメントを表示します。
isInUse 管理対象セットがそのファームウェア・バージョンを使用するかどうかを表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Jython リストを使用:
    AdminTask.dpGetFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetFirmwareVersion('-interactive')

dpRemoveFirmwareVersion

dpRemoveFirmwareVersion コマンドは、DataPower アプライアンス・マネージャーからファームウェア・バージョンを除去します。 システムによってそのファームウェア・バージョンと関連付けられているファームウェアはそのまま残ります。 このコマンドを実行する前に、現在、管理対象セットが除去対象のファームウェア・バージョンを使用していないことを確認してください。

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

なし。

必須パラメーター

-firmwareVersionId
除去するファームウェア・バージョンの ID を指定します。(ストリング、必須)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpRemoveFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Jython リストを使用:
    AdminTask.dpRemoveFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpRemoveFirmwareVersion('-interactive')

dpSetFirmwareVersion

dpSetFirmwareVersion コマンドは、DataPower アプライアンス・マネージャーのファームウェア・バージョンを変更します。

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

なし。

必須パラメーター

-firmwareVersionId
変更するファームウェア・バージョンの ID を指定します。(ストリング、必須)

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

-userComment
ファームウェア・バージョンに保管するコメントを指定します。(ストリング、オプション)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSetFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15" -userComment "new user comment"')
  • Jython リストを使用:
    AdminTask.dpSetFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15', '-userComment', 'new user comment'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSetFirmwareVersion('-interactive')

dpCopyMSDomainVersion

dpCopyMSDomainVersion コマンドは、DataPower アプライアンス・マネージャーの管理対象ドメイン・バージョンを新規の管理対象セットにコピーします。

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

なし。

必須パラメーター

-managedSetId
対象となる管理対象セットの ID を指定します。(ストリング、必須)
-msDomainVersionId
コピーする管理対象ドメイン・バージョンの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpCopyMSDomainVersion('[-managedSetId myManagedSet -msDomainVersionId "myManagedSet:default:1"]')
  • Jython リストを使用:
    AdminTask.dpCopyMSDomainVersion(['-managedSetId', 'myManagedSet', '-msDomainVersionId', 'myManagedSet:default:1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpCopyMSDomainVersion('-interactive')

dpGetAllDomainNames

dpGetAllDomainNames コマンドは、DataPower アプライアンス上の各ドメインの名前を表示します。

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

なし。

必須パラメーター

-applianceId
DataPower アプライアンス・マネージャー内の、表示するアプライアンスの ID を指定します。(ストリング、必須)

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

-managed
管理対象ドメインを戻すかどうかを示します。 managed または unmanaged のパラメーターを指定しなかった場合、またはその両方のパラメーターを指定した場合、このコマンドは、アプライアンス上の各ドメインの名前を戻します。(ストリング、オプション)
-unmanaged
コマンドで管理対象外のドメインを戻すかどうかを示します。 managed または unmanaged のパラメーターを指定しなかった場合、またはその両方のパラメーターを指定した場合、このコマンドは、アプライアンス上の各ドメインの名前を戻します。(ストリング、オプション)

戻り値

このコマンドは、アプライアンス内のそれらドメインの名前のストリング配列を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetAllDomainNames('[-applianceId "00605 20356" -managed -unmanaged]')
  • Jython リストを使用:
    AdminTask.dpGetAllDomainNames(['-applianceId', '00605 20356', '-managed', 
     '-unmanaged'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetAllDomainNames('-interactive')

dpGetAllMSDomainIds

dpGetAllMSDomainIds コマンドは、DataPower アプライアンス・マネージャーの管理対象セット内の各ドメインの ID を表示します。

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

なし。

必須パラメーター

-managedSetId
対象となる管理対象セットの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、管理対象セット内のそれらドメインの ID を含んだストリング配列を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetAllMSDomainIds('[-managedSetId myManagedSet]')
  • Jython リストを使用:
    AdminTask.dpGetAllMSDomainIds(['-managedSetId', 'myManagedSet'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetAllMSDomainIds('-interactive')

dpGetAllMSDomainVersionIds

dpGetAllMSDomainVersionIds コマンドは、DataPower アプライアンス・マネージャーの管理対象セット内にあるドメインの各ドメイン・バージョンの ID を表示します。

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

なし。

必須パラメーター

-msDomainId
表示する管理対象ドメインの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、管理対象セットのドメインに関して、存在する各ドメイン・バージョンの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetAllMSDomainVersionIds('[-msDomainId ms1:domain1]')
  • Jython リストを使用:
    AdminTask.dpGetAllMSDomainVersionIds(['-msDomainId', 'ms1:domain1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetAllMSDomainVersionIds('-interactive')

dpGetMSDomain

dpGetMSDomain コマンドは、DataPower アプライアンス・マネージャーの管理対象セット内のドメインを表示します。

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

なし。

必須パラメーター

-msDomainId
表示する管理対象ドメインの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、管理対象セット内の対象となるドメインの属性が含まれたプロパティー・オブジェクトを戻します。
表 6. コマンド属性. 以下の表は、このコマンドが戻す各属性についての追加情報を示したものです。
属性 説明
msDomainId そのドメインの ID を表示します。
managedSetId そのドメインが属す管理対象セットの ID を表示します。
name そのドメインの名前を表示します。
desiredDomainVersionId 管理対象セットがそのドメインに対して使用するドメイン・バージョンの ID を表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetMSDomain('[-msDomainId ms1:domain1]')
  • Jython リストを使用:
    AdminTask.dpGetMSDomain(['-msDomainId', 'ms1:domain1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetMSDomain('-interactive')

dpGetMSDomainVersion

dpGetMSDomainVersion コマンドは、DataPower アプライアンス・マネージャーの管理対象ドメイン・バージョンを表示します。

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

なし。

必須パラメーター

-msDomainVersionId
対象となる管理対象ドメイン・バージョンの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、管理対象セット内の対象となるドメイン・バージョンの属性が含まれたプロパティー・オブジェクトを戻します。
表 7. コマンド属性. 以下の表は、このコマンドが戻す属性についての追加情報を示したものです。
属性 説明
msDomainVersionId その管理対象ドメイン・バージョンの ID を表示します。
msDomainId その管理対象ドメインの ID を表示します。
versionNumber バージョン番号を表示します。
timestamp システムがコピーを作成した日付を表示します。
userComment 管理対象セット内のそのドメイン・バージョンとともに保管されたコメントを表示します。
isInUse 管理対象セットがドメインに対してそのドメイン・バージョンを使用するかどうかを表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
  • Jython リストを使用:
    AdminTask.dpGetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetMSDomainVersion('-interactive')

dpManageDomain

dpManageDomain コマンドは、管理対象セットにドメインを追加し、そのドメインの管理を開始します。

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

なし。

必須パラメーター

-managedSetId
管理する管理対象セットの ID を指定します。(ストリング、必須)
-domain
マスター・アプライアンス上の管理するドメインの名前を指定します。(ストリング、必須)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。 このタスクの完了時、結果属性の値には新規ドメインの ID が入っています。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpManageDomain('[-managedSetId testMS1 -domain default]') 
  • Jython リストを使用:
    AdminTask.dpManageDomain(['-managedSetId', 'testMS1', '-domain', 'default']) 

対話モードの使用例

  • Jython を使用:
    AdminTask.dpManageDomain('-interactive')

dpRemoveMSDomainVersion

dpRemoveMSDomainVersion コマンドは、DataPower アプライアンス・マネージャーから管理対象ドメイン・バージョンを除去します。

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

なし。

必須パラメーター

-msDomainVersionId
除去する管理対象ドメイン・バージョンの ID を指定します。(ストリング、必須)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpRemoveMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
  • Jython リストを使用:
    AdminTask.dpRemoveMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpRemoveMSDomainVersion('-interactive')

dpSetMSDomain

dpSetMSDomain コマンドは、DataPower アプライアンス・マネージャーの管理対象ドメインを変更します。

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

なし。

必須パラメーター

-msDomainId
変更する管理対象ドメインの ID を指定します。(ストリング、必須)

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

-desiredDomainVersionId
管理対象セット内の各アプライアンスに同期させるドメイン・バージョンの ID を指定します。(ストリング、オプション)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSetMSDomain('[-msDomainId  ms1:domain1 -desiredDomainVersionId ms1:domain1:1]')
  • Jython リストを使用:
    AdminTask.dpSetMSDomain(['-msDomainId', 'ms1:domain1', '-desiredDomainVersionId', 'ms1:domain1:1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSetMSDomain('-interactive')

dpSetMSDomainVersion

dpSetMSDomainVersion コマンドは、DataPower アプライアンス・マネージャーの管理対象ドメイン・バージョンを変更します。

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

なし。

必須パラメーター

-msDomainVersionId
変更する管理対象ドメイン・バージョンの ID を指定します。(ストリング、必須)

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

-userComment
ドメイン・バージョンに保管するコメントを指定します。(ストリング、オプション)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSetMSDomainVersion('[-msDomainVersionId ms1:domain1:2 -userComment "New Web 
     Service proxy for banking application"]')
  • Jython リストを使用:
    AdminTask.dpSetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:2',  '-userComment', 
     'New web service proxy for banking application'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSetMSDomainVersion('-interactive')

dpUnmanageDomain

dpUnmanageDomain コマンドは、管理対象セットからドメインを除去し、そのドメインの管理を停止します。

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

なし。

必須パラメーター

-msDomainId
管理対象セットから除去する管理対象ドメインの ID を指定します。(ストリング、必須)

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

-clean
管理対象セット内の各アプライアンスからドメインを削除します。(ストリング、オプション)

戻り値

clean パラメーターを指定した場合、このコマンドは、システムによって作成されたタスクの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpUnmanageDomain('-msDomainId testMS1:default -clean')
  • Jython リストを使用:
    AdminTask.dpUnmanageDomain(['-msDomainId', 'testMS1:default', '-clean'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpUnmanageDomain('-interactive')

dpCopyMSSettingsVersion

dpCopyMSSettingsVersion コマンドは、DataPower アプライアンス・マネージャーの管理対象設定バージョンを新規の管理対象セットにコピーします。

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

なし。

必須パラメーター

-managedSetId
対象となる管理対象セットの ID を指定します。(ストリング、必須)
-msSettingsVersionId
コピーする管理対象設定バージョンの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpCopyMSSettingsVersion('[-managedSetId myManagedSet -msSettingsVersionId "myManagedSet1:1"]')
  • Jython リストを使用:
    AdminTask.dpCopyMSSettingsVersion(['-managedSetId', 'myManagedSet', ,-msSettingsVersionId', 
     'myManagedSet1:1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpCopyMSSettingsVersion('-interactive')

dpGetAllMSSettingsVersionIds

dpGetAllMSSettingsVersionIds コマンドは、DataPower アプライアンス・マネージャーの管理対象セット内の各設定バージョンの ID を表示します。

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

なし。

必須パラメーター

-msSettingsId
対象となる管理対象設定の ID を指定します。(ストリング、必須)

戻り値

このコマンドは、管理対象セット内の対象となる設定のバージョンの ID を含んだストリング配列を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetAllMSSettingsVersionIds('-msSettingsId ms1:2')
  • Jython リストを使用:
    AdminTask.dpGetAllMSSettingsVersionIds(['-msSettingsId', 'ms1:2'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetAllMSSettingsVersionIds('-interactive')

dpGetMSSettings

dpGetMSSettings コマンドは、設定が属す管理対象セットの ID を表示します。

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

なし。

必須パラメーター

-msSettingsId
対象となる管理対象設定の ID を指定します。(ストリング、必須)

戻り値

このコマンドは、対象となる設定の属性が含まれたプロパティー・オブジェクトを戻します。
表 8. コマンド属性. 以下の表は、このコマンドが戻す属性についての追加情報を示したものです。
属性 説明
msSettingsId その設定の ID を表示します。
managedSetId その設定が割り当てられている管理対象 ID の ID を表示します。
desiredSettingsVersionId 管理対象セットが使用する設定バージョンの ID を表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetMSSettings('-msSettingsId ms1:2')
  • Jython リストを使用:
    AdminTask.dpGetMSSettings(['-msSettingsId', 'ms1:2'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetMSSettings('-interactive')

dpGetMSSettingsVersion

dpGetMSSettingsVersion コマンドは、DataPower アプライアンス・マネージャーの管理対象設定バージョンを表示します。

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

なし。

必須パラメーター

-msSettingsVersionId
対象となる管理対象設定バージョンの ID を指定します。(ストリング、必須)

戻り値

このコマンドは、管理対象セット内の対象となる設定バージョンの属性が含まれたプロパティー・オブジェクトを戻します。
表 9. コマンド属性. 以下の表は、このコマンドが戻す属性についての追加情報を示したものです。
属性 説明
msSetSettingsVersionId 管理対象セット内のその設定バージョンの ID を表示します。
msSettingsId 管理対象セット内の対象となる設定の ID を表示します。
timestamp システムがコピーを作成した日付を表示します。
versionNumber そのバージョンの番号を表示します。
userComment 管理対象セット内のその設定バージョンに関連付けられているコメントを表示します。
isInUse 管理対象セットが使用する設定バージョンの ID を表示します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetMSSettingsVersion('-msSettingsVersionId ms1:2')
  • Jython リストを使用:
    AdminTask.dpGetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetMSSettingsVersion('-interactive')

dpRemoveMSSettingsVersion

dpRemoveMSSettingsVersion コマンドは、DataPower アプライアンス・マネージャーから管理対象設定バージョンを除去します。

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

なし。

必須パラメーター

-msSettingsVersionId
除去する管理対象設定バージョンの ID を指定します。(ストリング、必須)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpRemoveMSSettingsVersion('-msSettingsVersionId ms1:2')
  • Jython リストを使用:
    AdminTask.dpRemoveMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpRemoveMSSettingsVersion('-interactive')

dpSetMSSettings

dpSetMSSettings コマンドは、DataPower アプライアンス・マネージャーの管理対象設定を変更します。

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

なし。

必須パラメーター

-msSettingsId
変更する管理対象設定の ID を指定します。(ストリング、必須)

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

-desiredSettingsVersionId
管理対象セット内の各アプライアンスに同期させる設定バージョンの ID を指定します。(ストリング、オプション)

戻り値

このコマンドは、このコマンドによって作成されたタスクの ID を戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSetMSSettings('-msSettingsId ms1 -desiredSettingsVersionId ms1:1')
  • Jython リストを使用:
    AdminTask.dpSetMSSettings(['-msSettingsId', 'ms1', '-desiredSettingsVersionId', 'ms1:1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSetMSSettings('-interactive')

dpSetMSSettingsVersion

dpSetMSSettingsVersion コマンドは、DataPower アプライアンス・マネージャーの管理対象設定バージョンを変更します。

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

なし。

必須パラメーター

-msSettingsVersionId
変更する管理対象設定バージョンの ID を指定します。(ストリング、必須)

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

-userComment
設定バージョンに保管するコメントを指定します。(ストリング、オプション)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpSetMSSettingsVersion('[-msSettingsVersionId ms1:2 -userComment "has new 
     timeserver added"]')
  • Jython リストを使用:
    AdminTask.dpSetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2', '-userComment', 'has 
     new timeserver added'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpSetMSSettingsVersion('-interactive')

dpGetAllTaskIds

dpGetAllTaskIds コマンドは、DataPower アプライアンス・マネージャーの各タスクの ID を表示します。

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

なし。

戻り値

このコマンドは、DataPower アプライアンス・マネージャーに現在存在する各非同期タスク ID のリストを戻します。

バッチ・モードの使用例

  • Jython ストリングおよびリストを使用:
    AdminTask.dpGetAllTaskIds()

dpGetTask

dpGetTask コマンドは、DataPower アプライアンス・マネージャーの特定のタスクに関する情報を表示します。

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

なし。

必須パラメーター

-taskId
対象となるタスクの ID を指定します。(ストリング、必須)

戻り値

表 10. コマンド属性. このコマンドは、対象となる非同期タスクに関する情報 (以下の属性を含む) を戻します。
属性 説明
taskId そのタスクの固有 ID を表示します。
taskDescription そのタスクの説明を表示します。
creationDate システムがそのタスクを作成した日時を表示します。
createdByUser そのタスクを作成したユーザーを表示します。
currentStep そのタスクの現在のステップ番号を表示します。
currentStepDescription 現在のステップの説明を表示します。
currentStepTimestamp そのタスクで現在のステップが最後に更新された日時を表示します。 システムは、オブジェクトの作成時、ステップの更新時、タスク完了のマーキング時、または例外発生時に、currentTimeStamp 属性を更新します。
エラー (error) そのタスクが終了する原因となった例外のエラー・メッセージがある場合に、そのエラー・メッセージを表示します。
totalSteps そのタスクの概算ステップ総数を表示します。 この引数は、タスクが完了しているかどうかを判別する目的では使用しないでください。 タスクが完了しているかどうかを判別する場合は、isComplete 属性を参照してください。
hasError そのタスクが正常に完了していない場合に値 true が表示されます。
hasUpdate そのタスクが更新されている場合に値 true が表示されます。
isComplete そのタスクが完了している場合に値 true が表示されます。
taskStatus そのタスクの状況を表す整数を表示します。 戻り値が 0 の場合、タスクがキューに入っており、システムはまだそのタスクを開始していません。 戻り値が 1 の場合、タスクの処理が進行中です。 戻り値が 2 の場合は、タスクが正常に実行され、完了しています。戻り値が 3 の場合は、タスクで例外が発生しています。
result そのタスクが戻した結果を表示します。 コマンドが出力を戻すかどうかを判別するには、該当のコマンドを参照してください。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpGetTask('-taskId 1')
  • Jython リストを使用:
    AdminTask.dpGetTask(['-taskId', '1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpGetTask('-interactive')

dpPurgeTask

dpPurgeTask コマンドは、DataPower アプライアンス・マネージャーの特定のタスクをパージします。 システムは、24 時間後に自動的にタスクを削除します。

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

なし。

必須パラメーター

-taskId
DataPower アプライアンス・マネージャー内の、パージするタスクの ID を指定します。(ストリング、必須)

戻り値

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

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.dpPurgeTask('-taskId 1')
  • Jython リストを使用:
    AdminTask.dpPurgeTask(['-taskId', '1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.dpPurgeTask('-interactive')

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



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