ヘッダーをスキップ
Oracle® Enterprise Manager Business Transaction Managementオンライン・ヘルプ
リリース12.1.0.6
E59455-01
  目次へ移動
目次		 索引へ移動
索引
前
前 		 次
次		  

10 コマンドおよびスクリプト

この章では、コマンドおよびスクリプトの実行に使用できる、Business Transaction Managementコマンドライン・インタフェース(CLI)について説明します。ここでは、CLIの使用方法、ヘルプとバージョン情報の取得方法、コマンドの安全な実行方法について説明し、コマンドとともに使用するように設定できるシステム変数を示します。内容は、次のとおりです。

Business Transaction Managementでは、コマンドに加えていくつかのユーティリティも提供します。これらについては、第11章「ユーティリティ」で説明します。

10.1 コマンドライン・インタフェース(CLI)について

Business Transaction Managementコマンドライン・インタフェース(CLI)では、コマンドラインからまたはスクリプト(bash、perl、ruby、DOS)を使用することで管理コマンドを発行できます。CLIは、UNIXおよびDOSコマンドラインから、およびBusiness Transaction Managementインストールを使用するその他の環境から使用できます。

CLIコマンドを使用すると、システムの構成、DNS別名の管理、レプリケーション問題の解決、サービスの登録、メタデータの管理、監視の制御、ポリシーの適用、データの移行またはレポートに必要なデータの生成を行うことができます。

CLI実行可能ファイル(Windowsではbtmcli.bat、UNIX系システムではbtmcli.sh)は、BTM_Install_Directory/toolsディレクトリにあります。Windowsプラットフォームでは、CLIはBusiness Transaction ManagementにバンドルされているJREを使用します。UNIX系システムでは、次のいずれかを実行して、使用するJREを指定する必要があります。

  • JAVA_HOME環境変数を設定し、BTMi_nstall_dir/_server/jreディレクトリを削除します。

  • BTM_install_dir/server/jreを有効なJREディレクトリへのリンクで置き換えます。

追加のアクションを実行するためのいくつかのコマンドライン・ユーティリティがあります。詳細は、11.1項「コマンドライン・ユーティリティについて」を参照してください。

10.1.1 ヘルプおよびバージョン情報の取得

すべてのCLIコマンドのリストとヘルプの概要を取得するには、次のコマンドを入力します。

C: > btmcli help

個々のコマンドの詳細なヘルプを取得するには、次のようなコマンドを入力します。

C: > btmcli help commandName

バージョン情報を取得するには、次のコマンドを使用します。

C: > btmcli -v

10.1.2 CLIコマンドおよびスクリプトの実行

Business Transaction Management CLIコマンドまたはスクリプトは、どのコマンド・シェルでも次の構文を使用して実行できます。

btmcli commandName commandFlags

単一のコマンドを実行するには、コマンド・プロンプトでコマンドとそのパラメータを指定します。次に例を示します。

C: btmcli encryptPassword -password "abracadabra"

スクリプトを実行するには、コマンド・プロンプトでスクリプトの名前を指定します。次に例を示します。

C: > myBTMScript.cmd

  • スクリプトには、任意のBusiness Transaction Management CLIコマンドを含めることができます。

  • スクリプト・ファイルの名前には、オペレーティング・システムに応じた拡張子(.cmd、.bat、.sh)が付いている必要があります。

  • スクリプトのコメントは、オペレーティング・システムに応じた形式にする必要があります。

  • スクリプトでは、10.1.5項「環境変数」で説明している環境変数を使用できます。

10.1.3 CLIコマンドにアクセスする場合のセキュリティ・オプション

ほぼすべてのCLIコマンドでは、コマンドを実行するために、資格証明をusername:passwordという形式で指定する必要があります。

この資格証明は、次のいずれかの方法で指定できます。

  • コマンドに対して-lフラグを使用します。

  • AP_USER_LOGIN環境変数を資格証明の値に設定します。この場合、-lフラグを指定する必要はありません。

-lフラグまたは環境変数のいずれを使用するかにかかわらず、次の2通りのうちの1つの方法で資格証明を指定できます。

  • コマンドの入力時にユーザー名とパスワードを直接指定するか、またはAP_USER_LOGIN環境変数をそのusername:password値に設定する方法。

  • 資格証明ストアにusername:password資格証明を作成し、その資格証明名をコマンドに渡すか、またはAP_USER_LOGIN環境変数をその資格証明名の値に設定する方法。

次の例では、btmcli configureコマンドを使用してそれぞれのケースを説明しています。

  1. 次のコマンドでは、-lフラグを使用してユーザー名とパスワードを指定しています。

    btmcli configure -i myConfigureFile -s http://uitst3:8080/btmcentral/sphere/
-l joanna:abracadabra

  2. 次のコマンドでは、AP_USER_LOGIN環境変数がjoanna:abracadabraに設定されているため、-lフラグは指定されません。

    btmcli configure -i myConfigureFile -s http://uitst3:8080/btmcentral/sphere

  3. 次のコマンドでは、JoannaCredという資格証明が、credStoreToolコマンドにより次のように定義されています。

    btmcli credStoreTool -createCred JoannaCred -credType up
-credValue joanna:abracadabra

    configureコマンドは次のようになります。

    btmcli configure -i myConfigureFile -s http://uitst3:8080/btmcentral/sphere/
-l JoannaCred

  4. 次のコマンドでは、JoannaCredという資格証明が、credStoreToolコマンドにより次のように定義されています。

    btmcli credStoreTool -createCred JoannaCred -credType up
-credValue joanna:abracadabra

    AP_USER_LOGIN環境変数はJoannaCred=joanna:abracadabraに設定されています。configureコマンドは次のようになります。

    btmcli configure -i myConfigureFile -s http://uitst3:8080/btmcentral/sphere/

10.1.4 コマンド一覧

次の表に、CLIコマンドのアルファベット順のリストと、コマンド・アクションの概要を示します。

コマンド名 説明
addBaseAddressAlias
 指定されたベース・アドレスのエントリ・ポイントの、指定された別名を追加します。この別名をベース・アドレスとして持つ他のエントリ・ポイントがすでにスフィアで認識されている場合には、2つのエントリ・ポイントとそのコンテンツがマージされ、重複したWSDLとエンドポイントは削除されます。
addNodeAlias
 登録済のノードにネットワーク別名を追加します。
addPathAlias
 addPathAliasコマンドを使用して、指定のWSDLまたはエンドポイントにアクセスするときに使用できる代替URLパスを表す別名を追加します。この別名を指定すると、検出時にアーティファクトが重複して作成されないようにできます。
configure
 構成xmlファイルを読み取り、その情報を使用して指定のスフィアURLに関連付けられているインストールを構成します。
configureAlivenessCheck
 デフォルトのpingを使用するのではなく、スフィアがエンドポイントの稼働ステータスをチェックする際に優先される方法を指定します。
createOrUpdateGenre
 新規サービス・ジャンルまたはエンドポイント・ジャンルの名前を指定し、新規ジャンルを表すために使用するカスタム・アイコンを示します。
createOrUpdatePolicy
 指定されたポリシーをスフィアで直接作成または更新します。
createSettingsDocument
 createSettingsDocumentコマンドを使用して、createOrUpdatePolicyコマンドへの入力として使用する設定ドキュメントを作成します。
credStoreTool
 資格証明ストアから、指定したタイプの資格証明を作成、取得または削除します。
deleteAll
 検出されたオブジェクトを、トランザクション、プロパティ、登録済サービスおよびコンテナなどの関連アーティファクトとともに削除します。削除された項目に関連付けられている履歴データも削除します。
encryptPassword
 Business Transaction Management暗号化エンジンを使用して、指定されたテキスト文字列を変換します。変換後の暗号テキストがコマンド出力に表示されます。
exportBusinessObjects
 createOrUpdatePolicyコマンドへの入力用の設定ドキュメントを作成します。
exportMessages
 指定された期間のエンドポイントのメッセージをエクスポートします。メッセージのエクスポートは、テストおよびデバッグで役立ちます。

ファイルにメッセージをエクスポートすることもでき、ユーザーが実行するかどうかに関係なく、出力は常にコンソールに送信されます。
exportPolicies
 指定されたポリシーをstdoutまたは指定の出力ファイルのいずれかにエクスポートします。ポリシーは名前またはタイプを指定してエクスポートするか、一連のポリシーを定義する問合せを使用してエクスポートできます。
exportPolicyTemplates
 指定されたポリシー・テンプレートをstdoutまたは指定の出力ファイルのいずれかにエクスポートします。ポリシー・テンプレートは名前またはタイプを指定してエクスポートするか、一連のポリシーを定義する問合せを使用してエクスポートできます。
exportProfile
 指定されたオブジェクトのプロファイル値を、stdoutまたは指定の出力ファイルのいずれかにエクスポートします。プロファイルは名前またはIDを指定してエクスポートできます。
exportSchedules
 ターゲット・スフィアからスケジュールをエクスポートします。スケジュールはファイルまたはstdoutに出力できます。スケジュールは、名前を指定してエクスポートするか、一連のポリシーを定義する問合せを使用してエクスポートできます。
exportTransactionDefns
 指定されたトランザクション定義をエクスポートします。出力ファイルを指定しない場合、定義はstdoutに送信されます。
getSetupData
 指定されたサービスの設定ファイルを標準出力に書き込みます。この設定ファイルを、putSetupDataコマンドの入力として使用できます。
importBusinessObjects
 指定されたXMLファイルで説明されている、指定された1つ以上のビジネス・オブジェクトをターゲット・スフィアにインポートします。このコマンドでは、デフォルトで、インポートされたオブジェクトより古い既存オブジェクトがすべて置き換えられます。
importPolicies
 以前に作成されたエクスポート・ファイルに含まれるポリシーをインポートします。インポートするポリシーは、-iパラメータで指定されたファイルから、またはそのようなファイルが指定されていない場合はstdinから取得されます。
importPolicyTemplates
 以前に作成されたエクスポート・ファイルに含まれるポリシー・テンプレートをインポートします。インポートするポリシー・テンプレートは、-iパラメータで指定されたファイルから、またはそのようなファイルが指定されていない場合はstdinから取得されます。
importProfile
 以前にエクスポートされたオブジェクト・プロファイルをシステムにインポートします。プロファイルをインポートしても新規オブジェクトは作成されず、既存オブジェクトのプロファイル属性が更新されるのみであることに注意してください。
importSchedules
 以前にエクスポートされたスケジュールをターゲット・スフィアにインポートします。このコマンドでは、デフォルトで、インポートされたスケジュールより古い既存スケジュールがすべて置き換えられます。
importTransactionDefns
 以前にエクスポートされたトランザクション定義を指定のスフィアにインポートします。このコマンドでは、デフォルトで、インポートされた定義より古い既存定義がすべて置き換えられます。
listInstruments
 システムのポリシー・テンプレートで定義されているインスツルメントおよび各インスツルメントの属性名とセグメントをリストします。この情報をretrieveObjectDataコマンドの引数として使用できます。
listNodeAliases
 単一のネットワーク・ノードまたは既知のすべてのネットワーク・ノードの別名をすべてリストします。
mergeServices
 指定されたサービスの2つのバージョンをマージします。このコマンドでは、ソース・バージョンを削除し、そのエンドポイントをターゲット・バージョンに移動します。

マージ後のターゲット・バージョンには、両方のバージョンのエンドポイントがすべて含まれます。ソース・バージョンに含まれているプロファイル属性またはメッセージ・プロパティで、マージ後のバージョンで保持する必要があるものは、ターゲット・バージョンで再作成する必要があります。
moveEndpoints
 指定されたサービスのソース・バージョンからターゲット・バージョンに1つ以上のエンドポイントを移動します。
moveMeasurements
 スフィアから削除したサービスまたはエンドポイントに対して収集される測定を、論理的に継続する他のエンドポイントまたはサービスに移動します。
putSetupData
 指定されたファイルまたは標準入力から設定ファイルを読み取り、それを指定されたサービスの設定データとして保存します。
registerDevice
 管理デバイスをスフィアに登録します。現在サポートされているデバイス・タイプは、ハードウェアおよびソフトウェアのロード・バランサのみで、完全にサポートされているロード・バランサはF5 BigIPのみです。

複数のデバイスを登録する場合は、setDefaultLoadBalancerコマンドを使用してデフォルト・デバイスを設定できます。
registerExternalContainer
 (監視対象コンテナに含まれない) 1つ以上のエントリ・ポイントのエンドポイントを、独自の外部コンテナにまとめます。これは手動で登録されたエンドポイントでのみ必要です。
registerMonitor
 モニター・エージェントをBusiness Transaction Managementに登録します。
removeBaseAddressAlias
 指定された別名を、指定のベース・アドレスのエントリ・ポイントから削除します。別名は、このエントリ・ポイントのみに対してローカルに定義されている必要があります。ネットワーク・ノード・レベルで定義されている別名は、removeNodeAliasコマンドを使用して削除する必要があります。
removeDuplicateEndpoint
 指定された重複エンドポイントを削除します。このコマンドは通常、パスは同じだが、システムで認識されなかったDNS別名が原因で異なるホスト名を持つ2つのエンドポイントをシステムが検出した場合に使用します。このコマンドを実行すると、これ以降の検出によって重複エンドポイントが再作成されないように、欠落している別名も追加されます。
removeNode
 スフィアからネットワーク・ノードを削除します。
removeNodeAlias
 登録済のノードから別名を削除します。
removePathAlias
 指定のWSDLまたはエンドポイントにアクセスするときに使用できる代替URLパスを表す別名を削除します。これ以降の登録や検出では、2つのパスが別々のものとして扱われます。
removePolicy
 適用済のポリシーを削除し、オプションでポリシーの削除が完了するまで待機します。
removePolicyTemplate
 指定されたポリシー・テンプレートをシステムから削除します。
renameEndpoint
 スフィアにある指定のエンドポイントのわかりやすい名前を変更します。
resetSphereUrl
 このスフィアに現在登録されているコンテナ・サービスのスフィアURLが、現在のスフィアURLと一致していることを確認します。このコマンドを使用する必要があるのは、スフィアのベース・アドレスが変わったときです。
retrieveObjectData
 1つ以上のオブジェクトのプロファイル・データと測定データを取得します。このデータは、レポート・ツールの入力として使用できます。
sendEventNotification
 通知サービスを使用してイベント通知を作成および送信します。通知の処理方法は、現在アクティブなサブスクリプションによって決定されます。
sendToNotifier
 通知サービスに処理のためにコマンドを送信します。コマンドはXML入力ファイルで指定されます。このコマンドは、通知サービスによって返されるレスポンス・ドキュメントを返します。
setBaselines
 管理対象オブジェクトのベースラインを設定します。入力ドキュメントの形式は、retrieveObjectDataコマンドの出力と同じです。
setDefaultLoadBalancer
 監視対象メッセージ・トラフィックから検出されたルーティング・エントリ・ポイントをモデリングするために使用するデフォルト・デバイスを設定します。

既知のロード・バランサが1つのみの単純な環境では、そのデバイスが自動的にデフォルトとして使用されます。追加のデバイスを登録した場合は、このコマンドを使用して、ルーティング・エントリ・ポイントのモデリングにどのデバイスを使用するかを設定します。
showService
 サービスのわかりやすい名前、修飾名または任意のエンドポイントのURLで指定された、サービスの構造を示します。サービスの1つのバージョンを指定したり(-version)、より詳細な情報を表示するように指定することもできます(-verbose)。
unmonitorEndpoint
 指定のエンドポイントが登録されているモニター・エージェントによる、エンドポイントの監視を停止します。監視が停止すると、パフォーマンス測定は記録されず、メッセージはログに記録されず、トランザクションはトレースされません。
unregister
 サービス、WSDLまたはエンドポイントをスフィアから登録解除します。
unregisterContainer
 指定されたコンテナを登録解除します。
unregisterMonitor
 指定されたモニター・エージェントをスフィアから登録解除します。このコマンドは、モニターが完全にオフラインになっているときにのみ使用してください。モニターは、システムが停止状態とマークするまで十分に長い時間オフラインにしてから登録解除してください。
updateProfileData
 指定したオブジェクト・セットのプロファイル属性データを更新します。このコマンドは既存オブジェクトのみを更新し、指定されたオブジェクトを見つけることができない場合はエラーを返します。

10.1.5 環境変数

次の表に、よく使用されるコマンド・フラグのかわりに、Business Transaction Managementコマンドで使用するよう定義できる環境変数を示します。

環境変数 対応するフラグ名 対応するフラグのロング名 説明
AP_SPHERE_URL -s -sphereUrl スフィアのURL。http://hostname:port/apcentral/sphere/

.NETの例: http://host:port/apcentral/sphere/soa.asmx
AP_USER_LOGIN -l -userLogin 次のいずれかの形式のスフィアのログイン資格証明。

username:password

credName=myCredentialName

通常、これらは管理権限を持つユーザーの資格証明です。

詳細は、12.3.1項「認証およびロール・マッピング」を参照してください。

encryptPasswordコマンドを使用して、CLIで使用するパスワードを暗号化できます。

10.1.6 属性名

CLIコマンドには、属性名をフラグ値として渡す必要があるものが多くあります。この項では、様々なオブジェクト・タイプの有効な属性名を示します。

エンドポイント属性

名前 名前 名前
エイリアス friendlyName operationsNote
binding gateway qualifiedName
businessContact genericNote relativeLocation
businessNote genre service
contact interface serviceQName
container isAlive relativeLocation
defaultCredentials lastIsAliveChangeDate service
dependsOnEndpoint lastManagementChangeDate serviceQName
デプロイメント lastManagementChangeIdentity serviceDescriptionURL
description lastUpdateIdentity supportContact
endpointAppProtocol lastUpdateMarker supportNote
endpointSoftwareType location targetEndpoint
endpointSource managingIntermediaries technicalContact
endpointTransportProtocol note technicalNote
endpointType 操作 testingNote
firstRegistryDate operationsContact uddiBusinessKey
-- -- uddiKey

操作属性

名前
dependsOn
operationName
operationType
propertyOverrides

インタフェース属性

名前 名前 名前
businessContact name supportNote
businessNote namespace technicalContact
classifications note technicalNote
contact 操作 testingNote
description operationsContact uddiBusinessKey
friendlyName operationsNote uddiKey
genericNote owningEndpoint --
lastUpdateIdentity sourceType --
lastUpdateMarker supportContact --

インタフェース操作属性

名前
classification
documentation
operationName
operationType
プロパティ
sampleMessageNotes

サービス属性

名前 名前 名前
alive lastIsAliveChangeDate serviceSource
applicationGroup lastManagementChangeDate serviceType
businessContact lastManagementChangeIdentity supportContact
businessNote lastUpdateIdentity supportNote
category lastUpdateMarker technicalContact
contact managedDescriptionURL technicalNote
deploymentNames note testingContact
description 操作 testingNote
documentation operationsContact uddiBusinessKey
endpoints operationsNote uddiKey
firstRegistryDate organization version
friendlyName originalDescriptionURL --
lastDeployDate primaryDeploymentName --
lastDeployIdentity qualifiedName --

トランザクション属性

トランザクション属性はfriendlyNameのみです。

コンテナ属性

名前 名前 名前
administratorUI lastIsAliveChangeDate phaseInLifeCycle
baseAddress lastDeployIdentity supportContact
businessContact lastDiscoveryDate supportNote
businessNote lastManagementChangeDate technicalContact
connectionLimit lastManagementChangeIdentity technicalNote
contact lastUpdateIdentity testingContact
containerInfo lastUpdateMarker testingNote
firstRegistryDate note uddiBusinessKey
friendlyName operationsContact uddiKey
genericNote operationsNote --
hostName osName --
implementationType osVersion --
ipAddress owner --
isAlive performanceRating --

デプロイメント属性

名前 名前 名前
businessContact isAlive supportContact
businessNote lastDeploymentDate supportNote
contact lastDeploymentIdentity technicalContact
container lastIsAliveChangeDate technicalNote
deploymentCategory lastUpdateIdentity testingContact
deploymentStatus lastUpdateMarker testingNote
deploymentType note uddiBusinessKey
description operationsContact uddiKey
firstRegistryDate operationsNote --
friendlyName pluginAgentPossible --
genericNote pluginAgentPossibleText --

連絡先ID属性

名前
emailAddress
informationURL
name
phoneNumber
usage

ノート・タイプ属性

theNoteおよびusageの2つの属性名があります。

説明属性

contactsおよびnotesの2つの属性名があります。

10.2 addBaseAddressAlias

addBaseAddressAliasコマンドを使用して、指定のベース・アドレスを持つエントリ・ポイントの指定された別名を追加します。

この別名をベース・アドレスとして持つ他のエントリ・ポイントがすでにスフィアで認識されている場合には、2つのエントリ・ポイントとそのコンテンツがマージされ、重複したWSDLとエンドポイントは削除されます。

addBaseAddressAliasコマンドで実行される内容は、removeDuplicateEndpointコマンドでベース・アドレスのみが異なる2つのエンドポイントを指定した場合と同じになります。

-forceオプションを使用すると、エントリ・ポイントとその別名が作成された後に、このエントリ・ポイントに対応するすべてのエンドポイントが検出または登録されるため、重複エンドポイントが(誤って)作成されること自体がなくなります。

addNodeAliasコマンドにより作成される別名とは異なり、addBaseAddressAliasコマンドまたはremoveDuplicateEndpointコマンドにより作成される別名は単一のエントリ・ポイントに適用されます。ネットワーク・ノード・レベルで、同じ別名がメッセージの監視または検出により自動的に、またはaddNodeAliasコマンドにより手動で追加されると、ローカルで定義されたエントリ・ポイントの別名がその別名で置き換えられ、この別名を、removeBaseAddressAliasコマンドを使用して削除することはできません。

このコマンドで定義する変更をコミットする前に、コマンドの結果をプレビューできます。プレビュー後、実際に変更を実行するには、-Pオプションを指定せずにもう一度コマンドを実行する必要があります。

addBaseAddressAliasコマンドにより作成した別名を削除するには、removeBaseAddressAliasコマンドを使用します。

12.7項「検出問題の解決」では、このコマンドを使用して検出の問題を解決する方法について説明しています。

コマンド構文

btmcli addBaseAddressAlias -baseAddress address -alias address [-P] [-f]
                           -s sphereURL -l username:password
名前 ロング名 説明
-baseAddress -- スフィアにある既存のエントリ・ポイントのベース・アドレス。scheme://host:port/という形式を使用します。
-alias -- 前述のエントリ・ポイントの別名として使用するベース・アドレス。
-P -preview コマンドの結果をプレビューしますが、実際にはモデルを変更しません。
-f -force 指定のベース・アドレスを持つエントリ・ポイントが存在しない場合に、それを作成します。このオプションを使用して、重複エンドポイントが検出される前に、システムに別名を指定します。
-s -sphereUrl スフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、addBaseAddressAliasコマンドを示します。

btmcli addBaseAddressAlias -baseAddress http://jbujes:8080 
          -alias http://1.2.3.4:8080 -s http://localhost:8080/btmcentral/sphere/
          -l admin:abracadabra

10.3 addNodeAlias

addNodeAliasコマンドを使用して、正規名で示されるネットワーク・ノードに指定された別名を追加します。ノードが存在しない場合は、ノードも作成される-forceオプションを指定しないかぎり、別名は追加されません。

addNodeAliasコマンドで作成される別名を削除するには、removeNodeAliasコマンドを使用します。

このコマンドを使用して検出の問題を解決する方法の詳細は、12.7項「検出問題の解決」を参照してください。

コマンド構文

btmcli addNodeAlias -n nodeName -alias aliasName [-f]
                    -s sphereURL -l username:password
名前 ロング名 説明
-n -name ネットワーク・ノードの正規名。通常は完全修飾ドメイン名です。たとえば、jbujes-myPC.edgility.comです。
-alias -alias ネットワーク・ノードの別名。これには、ドメイン名または静的IPアドレスを指定できます。
-f -- ネットワーク・ノードが不明の場合でも、別名(およびその正規ネットワーク・ノード)を強制的に作成します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、addNodeAliasコマンドを示します。

btmcli addNodeAlias -n jbujesPC.edgility.com -alias Athena 
       -s http://localhost:8080/btmcentral/sphere/ -l admin:abracadabra

10.4 addPathAlias

addPathAliasコマンドを使用して、指定のWSDLまたはエンドポイントにアクセスするときに使用できる代替URLパスを表す別名を追加します。この別名を指定すると、検出時にアーティファクトが重複して作成されないようにできます。

通常、パス別名は次のいずれかの状況で自動的に追加されます。

  • registerコマンドがHTTPリダイレクトを検出し、リダイレクトされたURLで作成されたサービス記述子に元のURLを別名として追加する場合。

  • ユーザーがremoveDuplicateEndpointコマンドを使用して、既存エンドポイントについて、非正規URLで監視されているメッセージ・トラフィックが原因で作成された不要な重複を削除する場合。

2番目の状況では、元のエンドポイントが登録または検出されるときに別名を追加することで、重複の作成を防止できます。したがって、テストでこの問題が観測された環境の再作成に使用されたスクリプトに、addPathAliasコマンドを追加することができます。

addPathAliasコマンドで作成される別名を削除するには、removePathAliasコマンドを使用します。

ホスト名の別名についてはaddNodeAlias、WSDLのURLのオーソリティにおける他の別名についてはaddBaseAddressAliasも参照してください。

このコマンドの使用方法の詳細は、「検出問題の解決」の項を参照してください。

コマンド構文

btmcli addPathAlias -s wsdlUrl | -e endpointUrl -alias pathAlias
                    -s sphereUrl -l username:password
名前 ロング名 説明
-w -wsdlUrl 別名を追加するWSDL (サービス記述子)の完全URL。
-e -endpointUrl 別名を追加するエンドポイントの完全URL。複数のエンドポイントが一致する場合は、そのすべてに別名が追加されます。
-alias -- 同じ記述子またはエンドポイントにマップされる代替パス。これは、/で始まるURLのパス部分のみです。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、addPathAliascommandを示します。

btmcli addPathAlias -e http://jbujes:7001/bookmart/credit/CreditService
          -alias /bookmart/amex/CreditService
          -s http://jbujes:8080/btmcetnral/sphere/ -l admin:abracadabra

10.5 configure

configureコマンドを使用して、Business Transaction Managementを、ブラウザベースの構成ウィザードのかわりに初期構成に使用するように構成します。configureコマンドは、Business Transaction Managementの様々な設定を含む入力ファイルとともに使用します。

configureコマンドを実行する前に、組込みデータベースとOracle Databaseのいずれに情報を保存するかを決定する必要があります。Oracle Databaseに情報を保存する場合は、configureコマンドを実行する前にデータベースをインストールして設定する必要があります。

構文の説明に続く項では、構成プロセスおよび入力ファイルに関する追加情報を示します。

コマンド構文

btmcli configure -i inputFile -sphereUrl -l username:password
名前 ロング名 説明
-i -inputFile Business Transaction Managementインストールの構成に使用する構成ファイルへのパス。
-s -sphereUrl 構成するスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、configureコマンドを示します。

btmcli configure -i myConfigFile.xml -s http://localhost:8080/btmcentral/sphere/
                  -l admin:abracadabra

10.5.1 configureコマンドの動作

configureコマンドは、すべてのBusiness Transaction Managementサービスについて、現在の構成の状態を確認します。すべてのサービスが構成済の状態である場合、コマンドは終了し、Business Transaction Managementが構成済であることをユーザーに通知します。構成済のサービスと未構成のサービスが混在している場合、configureコマンドは未構成のサービスの構成を試みます。エラーまたは例外が発生した場合は、Business Transaction Managementによりエラーが記録され、構成は続行します。configureコマンドが完了すると、成功および失敗したサービス構成をすべて示すメッセージが返されます。

すべてのBusiness Transaction Managementサービスが正常に構成された場合、このコマンドから構成済のメッセージが返されます。

エラーが発生した構成試行の後で、もう一度configureコマンドを実行でき、実行すると、前回の構成試行でエラーが返されたサービスの構成がシステムにより試行されます。configureコマンドでは、構成の成功が報告されたサービスの再構成は行われません。

正常に構成されたサービスを再構成するには、getSetupDataおよびputSetupDataコマンドを実行します。

Business Transaction Managementサービスを再構成した場合は必ず、サーバーを再起動する必要があります。

10.5.2 構成ファイル

ブラウザベースの構成ウィザードを使用してBusiness Transaction Managementをインストールおよび構成した場合、essentialConfiguration.xmlという名前の構成ファイルが作成されます(各種プラットフォーム上での場所は、12.4項「Business Transaction Managementのバックアップおよびリストア」を参照してください)。このファイルは、新規Business Transaction Managementシステムを初期化する際の出発点として使用でき、この場合、目的の設定を指定するようにファイルの内容を変更する必要があります。このファイルがconfigureコマンドの入力ファイルになります。構成ファイル内のプリファレンス名およびその値では、いずれも大文字と小文字が区別されます。

構成ウィザードとは異なり、configureコマンドでは、構成の途中で停止して後で構成を再開することができません。必須パラメータがファイルに含まれていないとconfigureコマンドによってエラーが返されるため、configureコマンドには完全な構成ファイルが必要です。

パスワードの暗号化

構成ファイルに暗号化されたパスワードを設定するには、encryptPasswordコマンドを実行し、生成された値をコピーして構成ファイルに貼り付けます。

構成ファイルで平文のパスワードを使用した場合、Business Transaction Managementでは、該当するシステム・サービスの設定データに構成情報を保存するときにパスワードが暗号化されます。

構成ファイルのパラメータ

次の表に、configureコマンドの構成ファイルで使用するパラメータを示します。

別名のプリファレンス

Business Transaction Managementの一元的サービス(スフィア、パフォーマンスおよびトランザクション監視)を実行しているノードの別名値を指定できます。いずれの場合も、プリファレンス値は、それぞれのサーバー上のサービスにアクセスするために使用できる代替DNS名/IPアドレスのカンマ区切りリストです。

たとえば、スフィアURLがhttp://server1:8080/apcentral/sphere/ですが、server1マシンにspherehostというDNS別名もある場合、これを反映するためにsphereAliasesをspherehostに設定できます。マシンのプライマリIPアドレスは10.10.22.44ですが、スフィアのコンテナがすべてのlPアドレスをリスニングしており、マシンに10.10.22.47で実行されている2つ目のネットワーク・インタフェースがある場合は、これらの両方の別名を反映するためにsphereAliasesにspherehost, 10.10.22.47を設定します。

Business Transaction Managementの一元的サービスがすべて同じコンテナで実行されている場合(デモの例)、performanceAliasesおよびtransactionAliasesは無視されます。サーバーが異なるコンテナで実行されているものの、スフィアと同じマシン上である場合、別名は同じノード定義に適用されます。したがって、実際には、パフォーマンスおよびトランザクションの別名は個別に追跡されるのではなく、スフィアの別名に追加されます。

注意: すべてのパラメータはtype=booleanですが、acceptLicenseTermsパラメータは例外でtype=stringです。

パラメータ名 必須かどうか 説明
sphereUrl はい 構成するスフィアのURL。スフィアはbtmMainにデプロイされます。

値は、configureコマンドの-sフラグで指定される値と同じである必要があります。

http://hostname:port/btmcentral/sphere/
databaseChoice はい Business Transaction Managementデータベースで使用するデータベースのタイプを示します。

次のいずれかを使用します。

  • embedded (Javaプラットフォームの場合のみ)

  • oracle

embeddedを指定すると、それ以降のデータベース設定はすべて無視されます。
nodeAliases いいえ スフィアを実行しているノードの別名。

前述の別名のプリファレンスの説明を参照してください。
performance.nodeAliases いいえ パフォーマンス・サーバー(btmperformance.war)を実行しているノードの別名。

前述の別名のプリファレンスの説明を参照してください。
transaction.nodeAliases いいえ トランザクション・サーバー(btmexmrt.war)を実行しているノードの別名。

前述の別名のプリファレンスの説明を参照してください。
deploymentUsername、deploymentPassword はい Business Transaction Managementサービスの中には検出を実行するためにアプリケーション・サーバーと通信するものがあり、これらのサービスはアプリケーション・サーバーの管理ユーザーにマップされている一連の管理資格証明を必要とします。

これは、Tomcatを除くすべてのアプリケーション・サーバーで必須です。
agentServiceDB_databaseUrl、agentServiceDB_provider、agentServiceDB_userName、agentServiceDB_password いいえ エージェント・メッセージ・ログ・データベース。デフォルトでは、コンテナ内のすべてのエージェントがこのデータベースにログを記録します。この動作は初期構成後にオーバーライドできます。12.2.2項「メッセージ・ログ・データベースの設定」を参照してください。

databaseChoiceがEmbeddedの場合、これは必須です。
sphereServiceDB_databaseUrl、sphereServiceDB_provider、sphereServiceDB_userName、sphereServiceDB_password いいえ スフィア・データベース設定。

databaseChoice != Embeddedの場合は必須です。
exmServiceDB_databaseUrl、exmServiceDB_provider、exmServiceDB_userName、exmServiceDB_password databaseChoice != Embeddedの場合は必須です。 例外管理コンポーネント・データベース設定。

databaseChoice != Embeddedの場合は必須です。
performanceDB_databaseUrl、performanceDB_provider、performanceDB_userName、performanceDB_password databaseChoice != Embeddedの場合は必須です。 パフォーマンス・コンポーネント(SLM)データベース設定。

databaseChoice != Embeddedの場合は必須です。
performanceUrl はい Business Transaction Managementのパフォーマンス(SLM)コンポーネントに接続するために使用するURL (このコンポーネントはbtmPerformanceServerにデプロイされます)。パフォーマンス・コンポーネントは、構成時に実行されている必要があります。

btmPerformanceServerは通常、スフィアとは別のコンテナにデプロイされます。performanceURLをスフィアとは別のノードに指定した場合、Business Transaction Managementはリモート・コンテナもスフィアに登録します。
transactionURL いいえ Business Transaction Managementのトランザクション・コンポーネントに接続するために使用するURL (このコンポーネントはbtmTransactionServerにデプロイされます)。トランザクション・コンポーネントは、構成時に実行されている必要があります。

btmTransactionServerは通常、スフィアとは別のコンテナにデプロイされます。transactionURLをスフィアとは別のノードに指定した場合、Business Transaction Managementはリモート・コンテナもスフィアに登録します。
base_locationType、base_directory、

base_maxDuration、base_maxSize、base_numFiles

 オプション デフォルトでは、トレース・ログ・ファイルはBTMStorageRoot/deployment_name/system_service/logdirディレクトリに保存されます。

BTMStorageRootはアプリケーション・サーバーによって異なります(詳細は、12.4項「Business Transaction Managementのバックアップおよびリストア」を参照)。

別の場所にトレース・ログ・ファイルを保存するには、次に示すパラメータを使用します。

注意: これらのパラメータは、aqms、通知およびドメインの各システム・サービスのトレース・ログ・ファイル設定には影響しません。

  • base_locationType: この必須パラメータの値は、defaultまたはcustomである必要があり、値がcustomの場合は、base_directoryパラメータに値を指定する必要があります。

  • base_directory: Business Transaction Managementがログ・ファイルを作成するディレクトリです。base_locationType = customの場合、このパラメータに値を指定する必要があります。base_locationType = defaultの場合は、このプリファレンスを使用しないでください。

注意: 前述のパラメータを使用してディレクトリの場所を変更した場合、base_maxDuration、base_maxSizeおよびbase_numFilesパラメータ設定も含める必要があります。

  • base_maxDuration: ログ・ファイルの存続時間。この存続時間に達したログ・ファイルはローテーションされます(管理コンソールを使用してBusiness Transaction Managementを構成した場合、デフォルト設定は168です)。

  • base_maxSize: すべてのログ・ファイルの合計サイズ(KB単位)。ログ・ファイルがこの設定より大きくなると、ログ・ファイルのローテーションが実行されます(管理コンソールを使用してBusiness Transaction Managementを構成した場合、デフォルト設定は50000です)。

  • base_numFiles: 同時に存在できるログ・ファイル数(管理コンソールを使用してBusiness Transaction Managementを構成した場合、デフォルト設定は7です)。base_maxSizeおよびbase_numFilesは、各ログ・ファイルの最大サイズを指定します。特定のファイルでこのサイズに達すると、そのファイルのローテーションが実行されます。

10.6 configureAlivenessCheck

configureAlivenessCheckコマンドを使用して、コンテナまたはエンドポイントの稼働ステータスをスフィアがチェックするかどうか、およびチェックする場合に優先されるメソッドを指定します。

コマンド構文

btmcli configureAlivenessCheck -baseAddress baseAddress | -e epUrl1 [[epUrl2]...]
                               -method standard | skip | getwsdl |geturl | ping
                               [-alternateUrl alternateUrl]
                               [-endpointDreds username:password]
                               [-pingHostPort host:port]
                               -s sphereUrl -l username:password
名前 ロング名 説明
-baseAddress -- 稼働ステータス・チェックを構成するベース・アドレス。このフラグの効果は、-methodフラグの設定によって異なります。

-methodがstandard、geturlまたはpingに設定されている場合、ベース・アドレスは1回のみテストされ、このベース・アドレスにあるすべてのエンドポイントがこのベース・アドレスの稼働ステータス値を継承します。

-methodがgetwsdlに設定されている場合、指定されたベース・アドレスの各エンドポイントがそれぞれのWSDLをフェッチします。

-methodがskipに設定されている場合、このベース・アドレスに対して稼働ステータス・チェックは実行されませんが、-eまたは-alternateUrlフラグも指定されていれば、このベース・アドレスのエンドポイントが個別にチェックされます。
-e -endpointUrl 稼働ステータス・チェックを構成する1つ以上のエンドポイントURL。指定したURLのすべてのエンドポイントが同一に構成されます。
-method -- 稼働ステータス・チェックに使用するメソッド。次のいずれかを選択します。standard: 指定されたhost:portへのソケットをオープンおよびクローズします。

skip: 稼働ステータスをチェックしません。

getwsdl: エンドポイントのWSDLに対してHTTP GETを実行します。

geturl: 指定のURLに対してHTTP GETを実行します。

ping: -pingHostPortフラグで指定されたホストおよびポートに対してTCP pingを実行します。

詳細は、後述の説明を参照してください。
-alternateUrl -- ベース・アドレスまたはエンドポイントURLのかわりに使用するURL。geturlメソッドを使用する場合、このフラグは必須です。
-endpointCreds -- エンドポイントの代替URLをフェッチするときに使用する認証の資格証明(username:password)。その他の構成の場合には無視されます。
-pingHostPort -- エンドポイントURLの実際のベース・アドレスのかわりにpingを送信するホストおよびポート。このフラグは、メソッドにpingを指定した場合にのみ必須です。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定に使用できる様々なオプションの詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

監視するエンドポイントに最も適したメソッドを選択してください。たとえば、WebLogic JAX_RPCまたはJAX-WSサービスの場合、生成されたWSDLのフェッチは、コンテナが稼働中で、かつサービスがデプロイ済で稼働中である場合に成功するため、稼働ステータス・チェックは、有効かつ無害なサンプル・メッセージを送信する手間をかけることなく、実際にサービスをコールするのと同等の役割を果たします。任意のhttpフェッチ(geturl)と比較した場合のgetwsdlメソッドの利点は、ベース・アドレス・レベルでこれを指定することで、エンドポイントごとにconfigureAlivenessCheckコマンドを実行しなくても、独自のwsdlをフェッチするようにそのベース・アドレスの各エンドポイントの稼働ステータス・チェックを構成した場合と同じ結果が得られることです。しかし、次のような短所もあります。

  • 効率の損失が生じます(WSDLのサイズが大きくなり、多くのリソース・コストがかかるようになる可能性があります)。

  • 別のサーバーから手動作成またはコピー(あるいはその両方)されたWSDLのコピーから登録されたエンドポイントには適していません(これが該当する場合は、エンドポイントではなくそのHTTPサーバーの稼働ステータスをチェックしていることがになるためです)。

  • WSDLがスフィアにテキストとして保存されている、オブザーバにより検出されたエンドポイントには適していません(これが該当する場合は、スフィアの稼働ステータスをチェックしていることになるためです)。

例

次の例に、稼働ステータス・チェックを実行する、getwsdlメソッドが指定されたconfigureAlivenessCheckコマンドを示します。

btmcli configureAlivenessCheck -baseAddress http://jbujesPC:8080 -method getwsdl
                  -s http://localhost:8080/btmcentral/sphere/ -l admin:abracadabra

10.7 createOrUpdateGenre

createOrUpdateGenreコマンドを使用して、指定されたサービス・ジャンルまたはエンドポイント・ジャンルの定義をスフィアで作成または更新します。ジャンル・オブジェクトは、わかりやすい名前やアイコンといった、サービスおよびエンドポイント・タイプ情報を適切に表示するために必要な情報を提供します。

一般的に、このコマンドはオブザーバがオフサイクルでリリースされた場合に使用されます。そのような場合、新規ジャンルの認識方法およびそのタイプのサービスまたはエンドポイントを表示する方法を現行システムに指示するために使用するcreateOrUpdateGenreコマンドに関する明示的な説明が示されます。

コマンド構文

btmcli createOrUpdateGenre -n name -id id
                           -t service | endpoint [iconUrl iconUrl]
                           -overwrite
                           -sphereUrl -l username:password
名前 ロング名 説明
-n -name ユーザーに対して表示されるジャンルの名前(わかりやすい名前)。慣例では、ジャンルのIDとして使用される修飾名のローカル名とするのが一般的です(IDがQNameとして指定された場合)。

指定された値は、サービスおよびエンドポイントの「タイプ」フィールドに表示される文字列として使用されます。たとえば、WEB_SERVICE、JAXRPC、DATABASEです。
-id -- ジャンルの一意の識別子。慣例では、urn:com.amberpoint.servicegenresというネームスペースを持つ修飾名として指定することが一般的です。この値は、サービスまたはエンドポイント(あるいはその両方)の検出時にオブザーバから返されるジャンル識別子と一致している必要があります。例: urn:com.amberpoint.servicegenres:JAXRPC
-t -type このジャンルがサービス・タイプとエンドポイント・タイプのどちらを表しているかを示します。
-iconUrl -- 管理コンソールでジャンルを示すために使用されるアイコンの場所をシステムに示すURL。

どのジャンルにも2つのアイコン・ファイルがあります。ファイル名はgreyTypeIcon.extおよびgreyTypeOperationIcon.extで、extの値はアイコン・ファイルのタイプ(gif、bmp、jpegまたはpng)を示します。Typeの値はEndpointまたはServiceのいずれかです。

  • 接頭辞asc://を含むURLは、アイコンがbtmuiアプリケーションのviews/images/genre/urlPathディレクトリ内にあることを示します。

  • その他のURLは、アイコン・ファイルのURLのベースとして直接使用されます。
-overwrite -- 同じIDの既存ジャンルを置き換えることができるかどうかを示すスイッチ。更新の実行時には、このスイッチを指定する必要があります。
-s -sphereUrl 取得する設定データを持つサービスが登録されているスフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、createOrUpdateGenreコマンドを使用して、MyGenreというエンドポイント・タイプを作成する方法を示します。

btmcli createOrUpdateGenre -name MyGenre 
                           -id urn:com.aberpoint.servicegenres:MyGenre
                           -s http://localhost:8080/btmcentral/sphre/
                           -l admin:abracadabra

10.8 createOrUpdatePolicy

createOrUpdatePolicyコマンドを使用して、指定されたポリシーをスフィアで直接作成または更新します。

ポリシーの作成または更新には、次の3つの手順が必要な場合があります。

  1. createSettingsDocumentコマンドを使用してテンプレート設定ドキュメントを生成します。

  2. 作成中のポリシーに必要な値を提供するように、生成されたドキュメントを編集します。

  3. 手順2で作成した設定ドキュメントを指定して、createOrUpdatePolicyコマンドを使用してポリシーを作成します。

新規ポリシーを作成するために指定する必要があるのは、テンプレート名、タイプおよび名前のみです。ポリシーに設定が必要な場合は、設定ドキュメントも指定する必要があります。追加情報を指定して、ポリシーの初期状態を指定するためのソース・テンプレートをより正確に識別できますが、これは必須ではありません。

ポリシーを更新するには、名前、タイプ、-overwriteフラグおよび更新する要素の引数を指定する必要があります。指定しない値は変更されません。ポリシー名およびバージョンによりポリシーが識別されるため、このコマンドを使用してこれらを変更することはできません。かわりに、目的の名前またはバージョン(あるいはその両方)を指定して新規ポリシーを作成します。

コマンド構文

btmcli createOrUpdatePolicy [-templateName templateName]
                            [-t type][-subType subType] [-templateVersion version]
                            -n name [-V version] [-desc description]
                            [-settings settingsDocument]
                            [-criteria criterion1 [criterion2]...]
                            [-enable] | [-disable]
                            [-overwrite] [-f]
                            [-s sphereUrl] -l username:password
名前 ロング名 説明
-templateName -- 新規ポリシーのベースとなるテンプレートの名前。

更新の実行時は、このパラメータは無視されます。
-t -type 新規ポリシーのポリシー・タイプ。

このパラメータは、指定されたポリシーがすでに存在するかどうかを判別するためにも使用されます。
-subType -- 新規ポリシーのポリシー・サブタイプ。

このパラメータは、指定されたポリシーがすでに存在するかどうかを判別するためにも使用されます。
-templateVersion -- ポリシーを作成するときのベースとなるテンプレートのバージョン。

更新の実行時は、このパラメータは無視されます。
-n -name 新規ポリシーの名前。

このパラメータは、指定されたポリシーがすでに存在するかどうかを判別するためにも使用されます。
-V -version 新規ポリシーのバージョン。

このパラメータは、指定されたポリシーがすでに存在するかどうかを判別するためにも使用されます。
-desc -description ポリシーの説明。
-settings -settingsDocument createSettingsDocumentコマンドで作成される、ポリシーの設定ドキュメント。
-criteria -- ポリシーの適用基準のリスト。各基準の形式は後述します。
-enable -- ポリシーを有効とマークします。
-disable -- ポリシーを無効とマークします。
-overwrite -- ポリシーがすでに存在する場合、指定された情報でそのポリシーを更新する必要があることを示します。
-f -force ポリシーが内部的に更新不可とマークされている場合でも、ポリシーを更新します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

適用基準

ポリシーを作成または変更するときに、どの監視対象オブジェクトにポリシーを適用できるかを判別するために使用する一連の基準を指定できます。各基準の形式は、次のとおりです。

monitoredObjectType [;query [,{UNION | EXCLUDE}]]+

基準の指定方法の詳細は、http://www.oracle.com/support/contact.htmlを参照するか、聴覚に障害のあるお客様は、http://www.oracle.com/accessibility/support.htmlをご利用ください。

例

次の例に、createOrUpdatePolicyコマンドを使用して、MyPolicyという既存ポリシーの施行を可能にする方法を使用します。

btmcli createOrUpdatePolicy -name MyPolicy -enable
                            -s http://localhost:8080/btmcentral/sphere/ 
                            -l admin:abracadabra

10.9 createSettingsDocument

createSettingsDocumentコマンドを使用して、createOrUpdatePolicyコマンドへの入力として使用する設定ドキュメントを作成します。

設定ドキュメントはXMLファイルです。設定ドキュメントのソースには、ポリシー・テンプレートまたは既存ポリシーを指定できます。

  • ポリシー・テンプレートを指定した場合、コマンドによって、そのポリシー・テンプレートのデフォルト設定ドキュメントが返されます。

  • ポリシーを指定した場合、コマンドによって、現行のポリシー・インスタンスの設定を持つ設定ドキュメントが返されます。設定ドキュメントをcreateOrUpdatePolicyコマンドに発行する前に、設定ドキュメントの値を編集できます。

ポリシーまたはポリシー・テンプレートのタイプおよびサブタイプを判別するには、ナビゲータで適切なオブジェクトを選択します。各ポリシーまたはポリシー・テンプレートのタイプおよびサブタイプがサマリー・ペインに表示されます。

コマンド構文

btmcli createSettingsDocument -n name [-t type] [-subType subType[ [-V version]
                              -fromPolicy [-o outputFile]
                              -s sphereUrl -l username:password
名前 ロング名 説明
-n -name その設定ドキュメントを使用するテンプレートまたはポリシーの名前。
-t -type その設定ドキュメントを使用するポリシー・テンプレートまたはポリシーのタイプ。
-subType -- その設定ドキュメントを使用するポリシー・テンプレートまたはポリシーのサブタイプ。
-V -version その設定ドキュメントを使用するポリシー・テンプレートまたはポリシーのバージョン。
-fromPolicy -- テンプレートではなく、既存のポリシー・インスタンスを使用して設定ドキュメントを作成する必要があることを示します。
-o -outputFile 設定ドキュメントが書き込まれるファイル。これを指定しない場合、設定ドキュメントは標準出力に送信されます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、createSettingsDocumentコマンドを使用して、MySettingsDocという設定ドキュメントを作成する方法を示します。

btmcli createSettingsDocument -namemySecurePolicy -o mySettingsDoc
                  -s http://localhost:8080/btmcentral/sphere/
                  -l admin:abracadabra

10.10 credStoreTool

credStoreToolコマンドを使用して、資格証明ストアから資格証明を作成、取得または削除します。このコマンドを使用すると、次の3種類の資格証明を作成できます。

  • username:password形式に基づく資格証明。

    この資格証明は、btmcliコマンドにアクセスするために使用します。ほぼすべてのコマンドでユーザー名とパスワードが必要です。

  • 信頼できる発行者と秘密に基づく資格証明。

    Business Transaction Managementコンポーネントでは、このタイプの資格証明を使用してコンポーネント間の信頼関係を確立します。

  • バイナリ資格証明(システム・デフォルト暗号化鍵のAES鍵)。

    AES暗号化鍵は、Business Transaction Managementコンポーネント間で送信される機密データを暗号化する場合、またはその機密データがデータベースまたはディスクに保存される場合に使用されます。

このコマンドを使用するには、その前に、『Business Transaction Managementインストレーション・ガイド』の説明に従ってOracle Java Platform Securityクラスをインストールして構成する必要があります。

credStoreToolコマンドの構文は、使用する資格証明のタイプによって異なります。後続の項では、資格証明の種類ごとに構文およびパラメータ情報を示します。

いずれの場合も、このコマンドを使用して、資格証明を作成したり、別のサーバーにコピーする必要がある場合に資格証明を取得したり、資格証明を削除することができます。

10.10.1 user:password資格証明の使用方法

このオプションは、コマンドライン自体またはスクリプトでユーザー名およびパスワードを指定するよりも安全です。この資格証明を使用してbtmcliコマンドにアクセスする方法の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

コマンド構文

btmcli credStoreTool -createCred credName [-credType up] 
                     [credValue username:password]

btmcli credStoreTool -getCred credName [-credType up] [-showPwd]

btmcli credStoreTool -deleteCred credName [-credType up]
名前 説明
-createCred 作成する資格証明の名前を指定します。
-getCred 取得する資格証明の名前を指定します。
-deleteCred 削除する資格証明の名前を指定します。
-credType 作成、取得または削除する資格証明の種類。

デフォルトはupです。
-credValue このオプションを指定しない場合、ユーザー名とパスワードの入力を求められます。入力したパスワードはアスタリスクで表示されます。
-showPwd getCredオプションの場合に、ユーザー名とパスワードを表示するかどうかを確認します。

10.10.2 信頼できる発行者と秘密資格証明の使用方法

Business Transaction Managementコンポーネントでは、このタイプの資格証明を使用して信頼関係を確立します。コンポーネントはサービスに対するリクエストを受信すると、それを実行する前に、リクエストの送信元が信頼できるかどうかをチェックします。

コマンド構文

btmcli credStoreTool -createCred credName credType is [-credValue issuer:secret]

btmcli credStoreTool -getCred credName -credType is [-showSecret]

btmcli credStoreTool -deleteCred credName -cretType is
名前 説明
-createCred 作成する資格証明の名前を指定します。
-getCred 取得する資格証明の名前を指定します。
-deleteCred 削除する資格証明の名前を指定します。
-credType 作成、取得または削除する資格証明の種類。
-credValue このオプションを指定しない場合、発行者と秘密の入力を求められます。入力した秘密はアスタリスクでマスクされます。
-showSecret getCredオプションの場合に、発行者と秘密を表示するかどうかを確認します。

10.10.3 バイナリ資格証明の使用方法

AES暗号化鍵は、Business Transaction Managementコンポーネント間で送信される機密データを暗号化する場合、またはその機密データがデータベースまたはディスクに保存される場合に使用されます。

コマンド構文

btmcli credStoreTool -createCred credName 
          -credType bin {credValue Base64-encoded-bytes | -genKey AlgName:KeySize}

btmcli credStoreTool -getCred credName credType bin [-showSecret]

btmcli credStoreTool -deleteCred credName -credType bin
名前 説明
-createCred 作成する資格証明の名前を指定します。
-getCred 取得する資格証明の名前を指定します。
-deleteCred 削除する資格証明の名前を指定します。
-credType 作成、取得または削除する資格証明の種類。
-credValue バイトのセットを指定します(Base64エンコード)。これらのバイトは、有効な暗号化鍵を表している場合と表していない場合があります。
-genKey AlgNameは、JCE (Java Cryptographic Extension)用に予約されたアルゴリズム名を表します。現在はAESのみがサポートされています。

KeySizeは、生成する鍵のサイズです。許容される鍵のサイズはアルゴリズムごとに異なります。AESの場合は、(バイト数ではなく)ビット数を表す128、192および256です。128は、基礎となるすべてのプラットフォームの暗号実装でサポートされているため、これが推奨値です。
-showSecret getCredオプションの場合に、Base64エンコード・バイト自体とともに、バイナリ資格証明のサイズ(バイト単位)を表示するかどうかを確認します。次に例を示します。

16 bytes long ... Base-64 = [qvw1wEOxprSeJf2TbtuK5w==]

このパラメータを指定しない場合、バイト数は表示されません。

10.11 deleteAll

deleteAllコマンドを使用して、すでに検出されているオブジェクトを、トランザクション、プロパティ、登録済サービス、デバイス、コンテナなどの関連アーティファクトとともに削除します。

これは、最初の検出構成によって検出されたオブジェクト数が多すぎたり、関連のないオブジェクトが検出された場合に役立ちます。このコマンドを使用すると、システムを再インストールしたり、監視対象エンティティおよび関連アーティファクトをすべて手動で削除しなくても最初からやりなおすことができます。


注意:

deleteAllコマンドを使用すると白紙の状態になるため、監視対象オブジェクトに関連する履歴データを含め、必要なデータが失われないよう慎重に使用する必要があります。BTMの使用開始時に、検出方式を微調整するために使用するのが最適です。本番環境では使用しないでください。

どのオブジェクトが削除されるかを確認するには、-previewオプションを指定してコマンドを実行します。-previewオプションを指定せずにもう一度コマンドを実行すると、それらのオブジェクトが実際に削除されます。

このコマンドの使用後、検出構成を調整して、希望の結果を生成するためにさらにトラフィックを実行できます。

コマンド構文

deleteAll [-f][-P]-s sphereUrl -l username:password
名前 ロング名 説明
-f -force 既存のトランザクション定義をすべて強制的に削除します。定義を保持するには、deleteAllコマンドを使用する前にそれらをエクスポートし、検出構成の再定義後に再インポートする必要があります。詳細は、後述の説明を参照してください。
-P -preview コマンドを実行せずに、削除されるオブジェクトのリストを表示することによりコマンドの効果を表示します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

説明

BTMの使用を開始する際、場合によっては、適切な検出構成が見つかるまで何回か試してみる必要があります。deleteAllコマンドを使用すると、簡単にやりなおすことができます。

検出結果が多すぎたり、関連性のない結果が得られることもよくあります。これは通常、SOAベースのアプリケーションやOSB環境の監視を有効にする、デフォルトのプローブ設定をそのまま使用している場合に起こります。

  • SOAベースのアプリケーションは、相互接続された多数の内部EJBコンポーネントに依存しています。

  • OSB WebLogicアプリケーション・サーバーは多数のサーブレットをホストしており、これらがEJBまたはその他のコンポーネントを呼び出します。

同様に、WEB_APPおよびEJBプローブもデフォルトで有効になっており、これにより、しばらくした後、予想を上回る結果が検出されます。

これらのコンポーネントをすべて表示した場合、情報が多すぎる可能性があります。関連性の高い情報のみに絞り込む必要があります。

また、他の要因によっても、監視結果がわかりにくくなる可能性があります。

  • 間違った場所にオブザーバをインストールしている場合。関連性の低いサービスやエンドポイントが検出されます。

  • BTMモニターの使用を最適化する方法は、BTMの動作を理解するまでは必ずしも明白ではありません。モニターを追加したり、モニターごとに異なるプローブを再割当てすることがあります。この変更の前後で検出されたオブジェクトは両方とも表示されるようになります。

  • デプロイメントを更新した結果、サービスまたはエンドポイントの登録が重複しているように見えるようになります。

要約すると、システムを再インストールしたり、監視対象エンティティおよび関連アーティファクトをすべて手動で削除することなく、最初からやりなおす必要があります。この操作は、deleteAllコマンドを使用して実行できます。

deleteAllコマンドでは、次のものに関するデータが削除されます。

  • 非システム・コンテナ

  • ユーザー・サービスおよびサービス・インタフェース

    ユーザー登録のエンドポイントおよび検出されたエンドポイントが両方削除されます。

  • デバイス

  • 依存性

  • プロパティ

  • トランザクション定義(-fオプションを使用した場合)

  • オブザーバとそのプローブ(インストールされたビットではなく、スフィアでのその表現のみ)

  • 前述の項目に関連して維持されているランタイム・データ

    これには、測定および取得されたメッセージ・データが含まれます。

後で必要になる可能性があるトランザクション定義が失われないようにするために、deleteAllコマンドで、それらを強制的に削除するには-forceオプションを使用する必要があります。これらの定義を後で使用する場合は、トランザクションをエクスポートし、検出構成を再定義した後にそれらを再インポートする必要があります。手動の相関を可能にするプロパティを使用している場合、BTMでは、依存性を指定するためにそれらのプロパティを再作成します。

deleteAllコマンドでは、次のものに関するデータは削除されません。

  • システムおよびユーザー・ポリシー

    これらは、新しく検出および登録されたエンティティに再適用されます。ポリシーを作成し、これらのポリシーが新しく検出されたものには適用されない場合、それらのポリシーを削除する必要が生じます。

  • コンシューマ

  • スケジュール

  • アラート

  • システム構成

例

次の例に、deleteAllコマンドを使用して、すべての検出されたアーティファクトおよび関連するアーティファクトをシステムから削除する方法を示します。コマンドの後に出力例を示します。

btmcli deleteAll 

Warning: This command will delete your discovered / registered items in BTM. Continue? (y/n) [n]: y
Deleted Services:
     OrderService
     ShippingService
     bookmartClient
     PurchasingDB
     CreditService
     WarehouseService
 
Deleted Containers:
    jmeredit-lap:9200
 
Deleted Observer Probes:
    Web Application
    Servlet
    Web Service
    JAX-RPC
    Database
    JDBC
    JMS Message Consumer
    JMS

10.12 encryptPassword

encryptPasswordコマンドを使用して、Business Transaction Management暗号化エンジンを使用して指定したテキスト文字列を変換したり、暗号化されたパスワードを標準出力に書き込みます。

続けて、出力文字列をコピーして貼り付け、資格証明を必要とするコマンドに提供できます。

コマンド構文

btmcli encryptPassword -password aPlainTextPswd
名前 ロング名 説明
-password -- Business Transaction Management暗号化エンジンを使用して暗号化するテキスト文字列。

同じテキスト文字列を暗号化するたびに生成される出力は、それぞれ一意の暗号文文字列になります。

例

btmcli encryptPasword -password "abracadabra"

10.13 exportBusinessObjects

exportBusinessObjectsコマンドは、ターゲット・スフィアから1つ以上の指定されたビジネス・オブジェクトをエクスポートします。このコマンドにより出力されるXMLドキュメントは、ビジネス・オブジェクトを別のターゲット・スフィアにインポートするために使用できます。

-queryフラグまたは-exportAllフラグを使用して、エクスポートするオブジェクトを指定できます。

コマンド構文

btmcli exportBusinessObjects [-exportAll] | [-query filterQuery ]
                             [-o outputFile ]
                             -s sphereUrl -l username:password
名前 ロング名 説明
-exportAll -- 該当するタイプのすべてのオブジェクトをエクスポートします。
-query -filterQuery filterQuery式で表される基準に一致するオブジェクトのみをエクスポートします。

フィルタ・ツールを使用して問合せを作成し、その問合せをコピーしてコマンドラインに貼り付けます。
-o -outputfile データが書き込まれるXMLファイルの名前。このフラグを省略すると、データは標準出力に書き込まれます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、exportBusinessObjectコマンドを使用してMyConsumersにデータを出力する方法を示します。

btmcli exportBusinessObject -exportAll -o MyConsumers
                   -s http://localhost:8080/btmcentral/sphere/
                   -l admin:password

10.14 exportMessages

exportMessagesコマンドを使用して、ロギングが有効になっている期間のエンドポイントのメッセージをエクスポート(リクエストおよび応答)します。メッセージのエクスポートは、テストおよびデバッグで役立ちます。

オプションで、XMLファイルにメッセージをエクスポートできます。ファイルを指定しない場合、出力はstdoutに送信されます。

重要: このコマンドが動作するには、メッセージ・ロギングが有効になっている必要があります。メッセージ・ロギングの詳細は、5.4項「トランザクションの定義、変更および削除」を参照してください。

コマンド構文

btmcli exportMessages -name name | -e endpointUrl
                      [-bn bindingName]
                      -baseDate date -baseTime time -duration minutes
                      [-outputFile outputFile]
                      [-max numberOfMessages]
                      -sphereUrl sphereUrl -l username:password
名前 ロング名 説明
-n -name メッセージをエクスポートする対象となるエンドポイントのわかりやすい名前。後述の説明を参照してください。
-e -endpointURL エンドポイントのURL。これがWebサービスの場合は、エンドポイントにアクセスする実際のURLを指定できます。それ以外のタイプのコンポーネントの場合は、管理コンソールの「プロファイル」タブを確認して、エンドポイントのURLを特定してください。

後述の説明も参照してください。
-bn -bindingName エンドポイントのバインディング(たとえば、SOAP/HTTP)。このパラメータを使用して、複数のバインディングを持つエンドポイントURLを明確化します。
-baseDate -- メッセージのエクスポート開始時のタイムスタンプで、yyyy-MM-dd形式の日付。
-baseTime -- メッセージのエクスポート開始時のタイムスタンプで、hh:mm:ss形式の時刻。
-duration -- ログ・メッセージがエクスポートされる期間を示す、起点時刻からの分数。指定された期間にエクスポートされたメッセージ数が-maxオプションで指定された値を超えた場合は、メッセージがエクスポートされる期間が短縮されることがあります。
-o -outputFile メッセージがエクスポートされるファイルのパス名。出力ファイルがすでに存在する場合は、コマンドが失敗します。

絶対パスを指定することをお薦めします。ファイル名のみを指定した場合、ホスト・アプリケーション・サーバーの起動元ディレクトリにファイルが作成されます。

重要: パスを指定した場合、コマンドが動作するのは、Business Transaction Managementをホストするプロセスに、指定されたディレクトリへの書込み権限がある場合のみです。
-max -- エクスポートするメッセージの最大数。値を指定しない場合、指定された期間すべてのメッセージがエクスポートされます。
-s -sphereURL スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

メッセージをエクスポートする対象のエンドポイントは、次の方法で指定できます。

  • エンドポイントURLが1つのエンドポイントと一意に関連付けられている場合は、-eオプションを使用します。

    -eオプションは、レプリケートされたサービスに属するエンドポイントを識別する場合にも役立ち、このようなケースでは、エンドポイント名は一意ではありませんが、エンドポイントURLは一意です。

  • エンドポイントのわかりやすい名前を指定するには、-nオプションを使用します。指定された名前でエンドポイントを一意に識別できる場合は、これが優先されるオプションです。

例

次のコマンドは、MyShippingServiceサービスのメッセージをエクスポートします。

btmcli exportMessages -name MyShippingService 
                      -baseDate 2010-3-15 -baseTime 12:15:30 -duration 10
                      -s http://localhost:8080/btmcentral/sphere/ -l admin:passme

10.15 exportPolicies

exportPoliciesコマンドを使用して、選択されたポリシーをstdoutまたは指定の出力ファイルのいずれかにエクスポートします。エクスポートするポリシーは、次のいずれかの方法で指定します。

  • ポリシーの名前: タイプ、サブタイプまたはバージョン(あるいはそのすべて)を使用して、さらに細かく指定できます。

  • ポリシーのタイプ: サブタイプまたはバージョン(あるいはその両方)を使用して、さらに細かく指定できます。

    ポリシーのタイプおよびサブタイプを判断するには、ナビゲータで「ポリシー」を選択します。各ポリシーのタイプおよびサブタイプがサマリー・ペインに表示されます。

ポリシーをエクスポートしたら、importPoliciesコマンドを使用してそれらを別のスフィアにインポートできます。

すべてのファイルをエクスポートできるわけではありません。スフィア環境間で移行できないデータには、次の項目があります。

  • トランザクション管理データベースで収集されたロギング・ポリシー・データ。

    管理対象サービスにロギング・ポリシーを適用することにより、収集されてファイルまたはデータベース記憶域のいずれかに書き込まれた情報は移行できません。

  • トランザクションで発生した例外的な状況のインスタンス・データ。

    AMSのトランザクション管理コンポーネントにより収集された情報は移行できません。

コマンド構文

btmcli exportPolicies 
             [[-n PName] [-t PType] [-subType PSubType] [-v Version]|[-exportAll]]
             [-o fileName]
             -s sphereUrl -l username:password
名前 ロング名 説明
-n -name エクスポートするポリシーの名前。
-t -type エクスポートするポリシーのタイプ。
-subType -- エクスポートするポリシーのサブタイプ。
-v -version エクスポートするポリシーのバージョン。
-exportAll -- すべてのポリシーをエクスポートすることを指定します。
-o -outputFile エクスポートの結果を格納するファイルを指定します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次のコマンドは、指定されたスフィアで認識されているすべてのポリシーをMyPoliciesというファイルにエクスポートします。

btmcli exportPolicies -exportAll -o C:\Home|MyPolicies
                      -s http://localhost:8080/btmcentral/sphere/
                      -l admin abracadabra

10.16 exportPolicyTemplates

exportPolicyTemplatesコマンドを使用して、選択されたポリシー・テンプレートをstdoutまたは指定の出力ファイルのいずれかにエクスポートします。エクスポートするポリシー・テンプレートは、次のいずれかの方法で指定します。

  • ポリシー・テンプレートの名前: タイプ、サブタイプまたはバージョン(あるいはそのすべて)の情報を使用して、さらに細かく指定できます。

  • ポリシー・テンプレートのタイプ: サブタイプまたはバージョン(あるいはその両方)を使用して、さらに細かく指定できます。

    ポリシー・テンプレートのタイプおよびサブタイプを判断するには、ナビゲータで「ポリシー・テンプレート」を選択します。各ポリシー・テンプレートのタイプおよびサブタイプがサマリー・ペインに表示されます。

コマンド構文

btmcli exportPolicyTemplates 
              [[-n Name][-t Type] [-subType subType][-v TmplVersion]]| -exportAll
              [-o fileName]
              -s sphereUrl -l username:password
名前 ロング名 説明
-n -name エクスポートするポリシー・テンプレートの名前。
-t -type エクスポートするポリシー・テンプレートのタイプ。
-subType -- エクスポートするポリシー・テンプレートのサブタイプ。
-v -version エクスポートするポリシー・テンプレートのバージョン。
-exportAll -- すべてのポリシー・テンプレートをエクスポートすることを指定します。
-o -outputFile エクスポートしたデータを格納するファイルを指定します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次のコマンドは、すべてのポリシー・テンプレートをMyPolicyTemplatesという出力ファイルにエクスポートします。

btmcli exportPolicyTemplates -exportAll -o C:\Home\MyPolicyTemplates
                             -s http://localhost:8080/btmcentral/sphere/
                             -l admin:abracadabra

10.17 exportProfile

exportProfileコマンドを使用して、指定されたオブジェクトのプロファイル値をエクスポートします。生成されたプロファイル情報は、指定されたファイルまたはファイルが指定されない場合はstdoutに書き込まれます。オブジェクトのタイプを指定し、さらに名前またはIDを指定することで、エクスポートするオブジェクトを指定します。

importProfileコマンドを使用すると、生成されたXMLファイルを別のスフィアにインポートできます。

コマンド構文

btmcli exportProfile -t objectType
                     [-n name] [-v version] | [-id id]
                     [-o fileName]
                     -s sphereUrl -l username:password
名前 ロング名 説明
-n -name エクスポートするプロファイルが属するオブジェクトの名前。
-t -type エクスポートするプロファイルが属するオブジェクトのタイプ。タイプには、deployment、service、interface、endpoint、container、DEPLOYMENT、SERVICE、INTERFACE、ENDPOINTまたはCONTAINERのいずれかを指定できます。
-V -version エクスポートするプロファイルが属するサービス・オブジェクトのバージョン。
-id -- エクスポートするプロファイル・データが属するオブジェクトのスフィアID。
-o -outputFile エクスポートの結果を格納するファイルを指定します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次のコマンドは、すべてのコンテナのプロファイル情報をエクスポートします。

btmcli exportProfile -t CONTAINER -o C:\Home|myContainers
                     -s http://localhost:8080/btmcentral/sphere/ -l admin:pass

10.18 exportSchedules

exportSchedulesコマンドを使用して、ターゲット・スフィアからスケジュールをエクスポートします。スケジュールはファイルまたはstdoutに出力できます。

すべてのスケジュール、特定のスケジュールまたは特定のタイプのスケジュールを指定できます。

エクスポート後、importSchedulesコマンドを使用して別のスフィアにスケジュールをインポートできます。

コマンド構文

btmcli exportSchedules -n Name | -query filterQuery | -exportAll
                       [-o fileName]
                       -s sphereUrl sphereUrl -l username:password
名前 ロング名 説明
-n -name エクスポートするスケジュールの名前。
-query -filterQuery エクスポートする一連のスケジュールを指定するAQL問合せ。

フィルタ・ツールを使用して問合せを作成し、その問合せをコピーしてコマンドラインに貼り付けます。
-exportAll -- すべてのスケジュールをエクスポートすることを指定します。
-o -outputFile エクスポートの結果を格納するファイルを指定します。このフラグを使用しない場合、出力はstdoutに送信されます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次のコマンドは、指定されたスフィアで認識されているすべてのスケジュールをMySchedulesというファイルにエクスポートします。

btmcli exportSchedules -exportAll -o C:\Home\MySchedules 
                       -s http://localhost/btmcentral/sphere/ -l admin:pass

10.19 exportTransactionDefns

exportTransactionDefnsコマンドを使用して、ターゲット・スフィアで認識されているトランザクション定義をエクスポートします。出力ファイルを指定しない場合、定義はstdoutに送信されます。

エクスポートした定義は、importTransactionDefnsコマンドを使用してインポートできます。

コマンド構文

btmcli exportTransactionDefns [-n Name] [-o fileName]
                              -s sphereUrl -l username:password
名前 ロング名 説明
-n -name エクスポートするトランザクションの名前。この値を指定しない場合、既存のトランザクション定義がすべてエクスポートされます。
-o -outputFile エクスポートの結果を格納するファイルを指定します。この値を指定しない場合、出力はstdoutに送信されます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次のコマンドは、すべてのトランザクション定義をMyTransactionsというファイルにエクスポートします。

btmcli exportTransactionDefns -o C:\Home\MyTransactions 
                        -s http://localhost:8080/btmcentral/sphere/ 
                        -l admin:abracadabra

10.20 getSetupData

getSetupDataコマンドを使用して、システム・サービスの設定ファイルを標準出力に書き込みます。

出力をファイルにリダイレクトし、ファイルを変更してから、そのファイルをputSetupDataコマンドの入力として使用してサービス設定データを保存できます。

あるサービスから設定データを取得して、別のサービスに転送することもできます。このコマンドでは、ターゲット・サービスが初期構成されているかは確認されません。

このコマンドを使用してシステムをバックアップする方法の詳細は、12.4項「Business Transaction Managementのバックアップおよびリストア」を参照してください。

コマンド構文

btmcli getSetupData -e endpointUrl -s sphereUrl -l username:password
名前 ロング名 説明
-e -endpointUrl システム・サービスの場所(URL)。
-s -sphereUrl 取得する設定データを持つサービスが登録されているスフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、getSetupDataコマンドを示します。

btmcli getSetupData -e http://localhost:8080/apcentral/policyManager
                    -s http://localhost:8080/btmcentral/sphere/
                    -l admin:abracadabra

10.21 importBusinessObjects

importBusinessObjectsコマンドは、指定されたXMLファイルで記述されている、1つ以上の指定のビジネス・オブジェクトをターゲット・スフィアにインポートします。現在、定義されているビジネス・オブジェクトはコンシューマ・ビジネス・オブジェクトのみであり、これを使用して、コンシューマごとにトランザクション情報をセグメント化します。

このコマンドでは、デフォルトで、インポートされたオブジェクトより古い既存オブジェクトがすべて置き換えられます。このコマンドを使用して、異なる環境間でデータを移行したり、一連のコンシューマを環境に移入することができます。

インポートするデータは、-inputFile引数または標準入力を使用して指定します。インポートするオブジェクトは、事前にexportBusinessObjectsコマンドを使用してエクスポートされている必要があります。

このコマンドを使用して環境に一連のコンシューマを移入する場合、最も難しいのは有効な入力ファイルの作成です。入力ファイルに設定する適切な形式を推測せずに、これを実行する方法を次に示します。

  1. 必要な場合は、カスタム属性を追加してビジネス・オブジェクトをカスタマイズします。

  2. 管理コンソールを使用してコンシューマを作成します。

  3. 出力ファイルの名前を指定して、exportBusinessObjectコマンドを実行します。手順2で作成したコンシューマに関するデータが、XMLファイルにエクスポートされます。

  4. 出力XMLファイルを調べます。ファイルに示されている形式を使用して、ファイルを拡張してさらにコンシューマを追加します。

    コンシューマの使用の詳細は、7.1項「コンシューマについて」を参照してください。

コマンド構文

btmcli importBusinessObjects [-i inputFile]
                   [-replace ALL | all | NEWER | newer | NONE | cleaned | CLEANED]
                   [-v] -s sphereUrl -l username:password
名前 ロング名 説明
-i -inputFile インポートするデータを含むファイルの名前。

入力ファイルには、インポートするビジネス・オブジェクトが1つ以上含まれている必要があります。
-replace -replacementLevel インポートしたオブジェクトがシステム内の既存オブジェクトに一致した場合の結果を決定します。

ALL: 既存オブジェクトをすべて置き換えます。

NEWER: インポートしたオブジェクトよりも古い既存オブジェクトを置き換えます。(デフォルト)

CLEANED: 既存のビジネス・オブジェクトをすべて削除してから、新規ビジネス・オブジェクトをインポートします。

NONE: 既存オブジェクトを置き換えません。
-v -verbose コマンド実行に関する詳細情報を表示します。
-s -sphereUrl スフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、importBusinessObjectコマンドを使用してMyConsumersというファイルからデータをインポートする方法を示します。

btmcli importBusinessObject -inputFile MyConsumers -replace ALL
                        -s http://localhost:8080/btmcentral/sphere/
                        -l admin:abracadabra

10.22 importPolicies

importPoliciesコマンドを使用して、以前にエクスポートしたポリシーをインポートします。

インポートするポリシーは、エクスポートされたファイルから取得されるか(-inputFileパラメータ)、ファイルが指定されていない場合はstdinから取得されます。

すべてのファイルをインポートできるわけではありません。スフィア環境間で移行できないデータには、次が含まれます。

  • トランザクション管理データベースで収集されたロギング・ポリシー・データ。

    管理対象サービスにロギング・ポリシーを適用することにより、収集されてファイルまたはデータベース記憶域のいずれかに書き込まれた情報は移行できません。

  • トランザクションで発生した例外的な状況のインスタンス・データ。

    Business Transaction Managementのトランザクション管理コンポーネントにより収集された情報は移行できません。

このコマンドでは、デフォルトで、インポートされたポリシーより古い既存ポリシーがすべて置き換えられます。

コマンド構文

btmcli importPolicies [-i inputFile]
                      [-replace ALL | all | NEWER | newer | NONE | none]
                      [-v] -s sphereUrl -l username:password
名前 ロング名 説明
-i -inputFile インポートするデータを含むファイルの名前。
-replace -replacementLevel インポートしたポリシーがシステム内の既存ポリシーに一致した場合の結果を決定します。

ALL: 既存ポリシーをすべて置き換えます。

NEWER: インポートしたポリシーよりも古い既存ポリシーを置き換えます。(デフォルト)

NONE: 既存ポリシーを置き換えません。
-v -verbose コマンド実行に関する詳細情報を表示します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、importPoliciesコマンドを使用してMyPoliciesというファイルからデータをインポートする方法を示します。

btmcli importPolicies -inputFile MyPolicies -replace ALL
                  -s http://localhost:8080/btmcentral/sphere/
                  -l admin:abracadabra

10.23 importPolicyTemplates

importPolicyTemplatesコマンドを使用して、以前に作成したエクスポート・ファイルに含まれるポリシー・テンプレートをインポートします。インポートするポリシー・テンプレートは、-iパラメータで指定されたファイルから取得されるか、ファイルが指定されない場合はstdinから取得されます。

このコマンドでは、デフォルトで、インポートされたテンプレートより古い既存テンプレートがすべて置き換えられます。

コマンド構文

btmcli importPolicyTemplates [-i inputFile]
                      [-replace ALL | all | NEWER | newer | NONE | none]
                      [-v] -s sphereUrl -l username:password
名前 ロング名 説明
-i -inputFile インポートするデータを含むファイルの名前。
-replace -replacementLevel インポートしたポリシー・テンプレートがシステム内の既存ポリシー・テンプレートに一致した場合の結果を決定します。

ALL: 既存ポリシー・テンプレートをすべて置き換えます。

NEWER: インポートしたポリシー・テンプレートよりも古い既存ポリシーを置き換えます(デフォルト)。

NONE: 既存ポリシー・テンプレートを置き換えません。
-v -verbose コマンド実行に関する詳細情報を表示します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、importPolicyTemplatesコマンドを使用してMyPolicyTemplatesからデータをインポートする方法を示します。

btmcli importPolicyTemplate -inputFile MyPolicyTemplates -replace NONE
                            -s http://localhost:8080/btmcentral/sphere/
                            -l admin:abracadabra

10.24 importProfile

importProfileコマンドを使用して、以前のオブジェクト・プロファイルをシステムにインポートします。インポートするプロファイル・データは、指定した入力ファイルまたはファイルが指定されていない場合はstdinから取得されます。

プロファイルをインポートしても新規オブジェクトは作成されず、既存オブジェクトのプロファイル属性が更新されるのみです。たとえば、サービス・プロファイルをインポートしてもサービスが作成されたり、システムに登録されることはなく、(検出または手動の登録により)すでに登録されているサービスのプロファイルが更新されるのみです。

コマンド構文

btmcli importProfile [-i importFile] [-m EXACT | BEST_FIT}
                     -s sphereUrl -l username:password
名前 ロング名 説明
-i -inputFile インポートするプロファイル・データを含むファイルの名前。指定しない場合、コマンドはstdinからデータをインポートします。
-- -match 一連の関連オブジェクトのプロファイルをインポートするときに使用し、インポートされたプロファイルがシステムに現在存在するオブジェクトとどの程度正確に一致している必要があるかを指定します。可能な値は次のとおりです。

  • EXACT: インポートしたプロファイルは、カーディナリティおよび構造の両方について、既存オブジェクトと完全に一致している必要があります。

  • BEST_FIT: インポートしたプロファイルは、既存オブジェクトに対して可能なかぎり照合されます。カーディナリティまたは構造の不一致は無視されます。これはデフォルト値です。
-s -sphereUrl スフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、importProfileコマンドを使用してMyContainersからデータをインポートする方法を示します。

btmcli importProfile -inputFile MyContainers -match EXACT
                     -s http://localhost:8080/btmcentral/sphere/
                     -l admin:abracadabra

10.25 importSchedules

importSchedulesコマンドを使用して、以前にエクスポートしたスケジュールをターゲット・スフィアにインポートします。

このコマンドでは、デフォルトで、インポートされたスケジュールより古い既存スケジュールがすべて置き換えられます。

コマンド構文

btmcli importPolicyTemplates [-i inputFile]
                      [-replace ALL | all | NEWER | newer | NONE | none]
                      [-v] -s sphereUrl -l username:password
名前 ロング名 説明
-i -inputFile インポートするデータを含むファイルの名前。これを指定しない場合、データはstdinからインポートされます。
-replace -replacementLevel インポートしたスケジュールがシステム内の既存スケジュールに一致した場合の結果を決定します。

ALL: 既存スケジュールをすべて置き換えます。

NEWER: インポートしたスケジュールよりも古い既存スケジュールを置き換えます。(デフォルト)

NONE: 既存スケジュールを置き換えません。
-v -verbose コマンド実行に関する詳細情報を表示します。
-s -sphereUrl スフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例では、MySchedulesというファイルからスケジュールをインポートし、すべての既存スケジュールを置き換えます。

btmcli importSchedules -inputFile MySchedules -replace ALL
                       -s http://localhost:8080/btmcentral/sphere/
                       -l admin:abracadabra

10.26 importTransactionDefns

importTransactionDefnsコマンドを使用して、以前にエクスポートしたトランザクション定義を指定のスフィアにインポートします。

このコマンドでは、デフォルトで、インポートされた定義より古い既存定義がすべて置き換えられ、トランザクションを定義するために必要なプロパティが欠落していれば、それらが再作成されます。

通常、エラーが含まれるトランザクションはインポートできません。-importWithErrorsフラグを設定するとトランザクションをインポートすることはできますが、無効な状態になります。その後、コンソール・ツールを使用してエラーを修正できます。エラーは、トランザクションの「プロファイル」タブに表示されます。

トランザクションが1つ以上のプロパティに依存していることがあります(たとえば、これらのプロパティが相関に使用されている場合)。この場合、トランザクションがインポートされる前に削除されたプロパティがあれば、システムによって再作成されます。トランザクションに必要のないプロパティは、システムで再作成されません。-failOnMissingPropertyフラグを指定すると、トランザクションで必要なすべてのプロパティを再作成できない場合にインポートが失敗するようにできます。次に例を示します。

  1. 操作AにプロパティXを作成し、このプロパティを使用してトランザクションの2つの操作を相関付けます。

  2. 操作BにプロパティYを作成します。このプロパティはトランザクションには必要ありませんが、特定の値を表面化させるために役立つ場合があります。

  3. トランザクションをエクスポートすると、トランザクション定義に影響するすべてのプロパティのコピーがシステムにより作成されます。

  4. ここでプロパティXを削除します。

  5. トランザクションを再インポートすると、トランザクション定義に必要なプロパティが欠落していることがシステムで認識されます。デフォルトでは、欠落しているプロパティが再作成されます。-failOnMissingPropertyフラグを指定している場合は、インポート操作が失敗します。

  6. トランザクションはプロパティYには依存していないため、システムではそのコピーは作成しません。このプロパティはエクスポート/インポート・プロセス中に失われます。これはトランザクションのインポート後に再作成できます。または、exportProfileおよびimportProfileコマンドを使用して、そのような定義に関係のないプロパティがシステムにより自動的に再作成されるように指定できます。

コマンド構文

btmcli importTransactionDefns [-i inputFile]
                              [-replace ALL | all | NEWER | newer | NONE |none]
                              [-failOnMissingProperty]
                              [-importWithErrors]
                              -s sphereUrl -l username:password
名前 ロング名 説明
-i -inputFile インポートするデータを含むファイルの名前。
-replace -replacementLevel インポートしたトランザクション定義がシステム内の既存定義に一致した場合の結果を決定します。

ALL: 既存定義をすべて置き換えます。

NEWER: インポートした定義よりも古い既存定義を置き換えます。(デフォルト)

NONE: 既存定義を置き換えません。
-- -failOnMissingProperty デフォルトでは、トランザクションが依存しているプロパティが欠落している場合、そのプロパティが再作成されます。プロパティが欠落している場合にインポートが失敗するようにするには、このフラグを指定します。
-- -importWithErrors このコマンドで、インポートしたトランザクションにエラーがある場合でもこのトランザクションを保存する場合に指定します。

このフラグを設定すると、コンソールでエラーを修正できます。通常は、定義にエラーがあるとインポートが失敗します。このフラグを設定すると、インポートは成功しますが、インポートされたトランザクションは無効な状態になります。その後、コンソール・ツールを使用してエラーを表示および修正できます。エラーは、トランザクションの「プロファイル」タブに表示されます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、importTransactionDefnsコマンドを使用してMyTxDefnsというファイルからデータをインポートする方法を示します。

btmcli importTransactionDefns -i MyTxDefns -replace NONE -failOnMissingProperty
                              -s http://localhost:8080/btmcentral/sphere/
                              -l admin:abracadabra

10.27 listInstruments

listInstrumentsコマンドを使用して、システムのポリシー・テンプレートで定義されているインスツルメントおよびその属性名とセグメントをリストします。この情報をretrieveObjectDataコマンドの引数として使用できます。

コマンド構文

btmcli listInstruments -s sphereUrl -l username:password
名前 ロング名 説明
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

サンプル出力

次に、listInstrumentsコマンドのサンプル出力を示します。

Avg Response Time
   Attribute Name: averageResponseTime
   Description: The average amount of time a transaction requires to complete,
                 or a service/operation requires to respond.
   Segmented By: 
           operation
           containingManagedObjectId
           clientAddress
           clientName
           businessObjectId
            businessObjectKey
Faults
    Attribute Name: faultCount
    Description: The number of faults generated by a service or operation.
    Segmented By: 
         operation
         containingManagedObjectId
         clientAddress
         clientName
         faultCode
         businessObjectId
         businessObjectKey

例

次の例に、listInstrumentsコマンドを示します。

btmcli listInstruments -s http://localhost:8080/btmcentral/sphere/
                       -l admin:abracadabra

10.28 listNodeAliases

listNodeAliasesコマンドを使用して、既知のすべてのノードまたは指定されたノードの別名をリストします。

コマンド構文

btmcli listNodeAlias [ n nodeName]
                     -s sphereUrl -l username:password
名前 ロング名 説明
-n -name ネットワーク・ノードの正規名。通常は完全修飾ドメイン名です。たとえば、jbujes-myPC.edgility.comです。

このフラグを指定しない場合、既知のノードすべての別名が表示されます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、listNodeAliasコマンドを示します。

btmcli listNodeAliases -n jbujesPC.edgility.com 
                       -s http://localhost:8080/btmcentral/sphere/
                       -l admin:abracadabra

10.29 mergeServices

mergeServicesコマンドを使用して、2つのサービスをマージ(つまり、重複を削除)します。このコマンドは、-Vフラグで指定したソース・バージョンを削除して、そのエンドポイントを-Tフラグで指定したターゲット・バージョンに移動します。2つのエンドポイントのマージが必要となるような検出の問題の詳細は、12.7項「検出問題の解決」を参照してください。

マージ後のターゲット・バージョンには、両方のバージョンのエンドポイントがすべて含まれます。ソース・バージョンに含まれているプロファイル属性またはメッセージ・プロパティで、マージ後のバージョンで保持する必要があるものは、ターゲット・バージョンで再作成する必要があります。

ソース・バージョンで保持されているすべての履歴データが、ターゲット・バージョンで保持されているデータにマージされます。いったんマージを完了すると、これら2つのサービス・バージョンについて集計された2つの別個のデータ・セットに戻すことはできません。

このコマンドで定義する変更をコミットする前に、コマンドの結果をプレビューできます。プレビュー後、実際に変更を実行するには、-Pオプションを指定せずにもう一度コマンドを実行する必要があります。

選択したエンドポイントをサービス・バージョン間で移動するには、moveEndpointsコマンドを使用します。

コマンド構文

btmcli mergeServices -n friendlyName | -qname qname
                     -V version
                     -T targetVersion [-P]
                     -s sphereUrl -l username:password
名前 ロング名 説明
-n -name バージョンをマージするサービスのわかりやすい名前。

2つのバージョンのわかりやすい名前が同じではない場合、-qnameフラグを使用してサービス名を指定する必要があります。
-qname -- バージョンをマージするサービスの修飾名。

修飾名の形式はWSDLtargetNamespace:serviceNameです。たとえば、http://amberpoint.com/orderService:CreditServiceSOAPです。
-V -version 指定されたターゲットにマージされるサービスのバージョン。

デフォルトの未指定バージョンを表すには、-文字列を使用します。
-T -targetVersion ソース・バージョンのマージ先となるターゲット・サービス・バージョン(-V)。マージ後、このバージョンには両方のバージョンのエンドポイントが含まれます。
-P -preview 実際にマージを実行せずに、マージの結果をプレビューする場合にこのフラグを指定します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、mergeServicesコマンドを示します。

btmcli mergeServices -f CreditService -X 1.5 -T 1.6
                     -s http://localhost:8080/btmcentral/sphere/
                     -l admin:abracadabra

10.30 moveEndpoints

moveEndpointsコマンドを使用して、指定されたサービスのソース・バージョンからターゲット・バージョンに1つ以上のエンドポイントを移動します。

エンドポイントの識別方法に関係なく、特定のWSDL内の1つのサービスについて定義された一連のエンドポイント全体をまとめて移動することしかできません。

このコマンドで定義する変更をコミットする前に、コマンドの結果をプレビューできます。プレビュー後、実際に変更を実行するには、-Pオプションを指定せずにもう一度コマンドを実行する必要があります。

moveEndpointsコマンドでは、測定は移動されません。エンドポイントの測定はそのエンドポイントに関連付けられたままになり、エンドポイントが新しいサービスに移動されても測定には何も行われません。古いサービス・バージョンの測定には、移動されたエンドポイントから以前に集計されたデータが引き続き含まれます。ターゲット・サービス・バージョンの測定履歴は変更されず、エンドポイントの新しい測定はサービスのターゲット・バージョンに含められます。

このコマンドで、以前に定義されていないバージョンを-Tフラグで指定し、-forceフラグを使用することで、サービスを2つに分割できます。

サービス・バージョン間ですべてのエンドポイントをマージするには、mergeServicesコマンドを使用します。

このコマンドを使用して検出の問題を解決する方法の詳細は、12.7項「検出問題の解決」を参照してください。

コマンド構文

btmcli moveEndpoints -n friendlyName | -qname qname -w wsdlUrl | -e endpointUrl
                     -V version -T targetVersion [-P]
                     -s sphereUrl -l username:password
名前 ロング名 説明
-n -name 移動するエンドポイントが属するサービスのわかりやすい名前。

2つのバージョンのわかりやすい名前が同じではない場合、qnameフラグを使用してサービス名を指定する必要があります。
-qname -- 移動するエンドポイントが属するサービスの修飾名。

修飾名の形式はWSDLtargetNamespace:serviceNameです。たとえば、http://amberpoint.com/orderService:CreditServiceSOAPです。
-w -wsdlURL 移動するエンドポイントが属するサービスを定義するWSDLファイルのURL。
-e -endpointUrl サービスのソース・バージョンに含まれるエンドポイントのURL。

WSDLで、同じURLの複数のエンドポイントに異なるバインディングが定義されている場合、エンドポイントURLによって、複数のエンドポイントが識別されます。これは、1つのサービスに対し複数のエンドポイントを定義するWSDLで一般的に発生する状況です。
-V -version 指定されたターゲットにマージされるサービスのバージョン。

デフォルトの未指定バージョンを表すには、-文字列を使用します。
-T -targetVersion ソース・バージョンのマージ先となるサービス・バージョン(-V)。マージ後、このバージョンには両方のバージョンのエンドポイントが含まれます。
-P -preview 実際にエンドポイントを移動せずに、移動の結果をプレビューする場合に、このフラグを指定します。
-f -force 指定されたターゲット・バージョンが存在しない場合に、新規サービス・バージョンを作成します。-newServiceNameフラグを使用すると、このサービスにソース・バージョンとは異なる名前を割り当てることができます。

-newServiceName -fオプションを使用する場合、-newServiceNameフラグを使用して、作成されるターゲット・バージョンのわかりやすい名前を指定できます。ターゲット・バージョンがすでに存在する場合、このフラグは無視されます。
-s -sphereUrl スフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、moveEndpointsコマンドを示します。

btmcli moveEndpoints -n catalogService 
                     -e http://test.myhost.com:7412/catalogMgmt/svcs/CatalogSvc
                     -V 1.5 -T 1.6 
                     -s http://localhost:8080/btmcentral/sphere/
                     -l admin:abracadabra

10.31 moveMeasurements

moveMeasurementsコマンドを使用して、スフィアから削除したサービスまたはエンドポイントについて収集される測定を、論理的に継続する他のエンドポイントまたはサービスに移動します。

注意: このコマンドを使用する場合は注意が必要です。システムでは、サービスやエンドポイントが実際に同じオブジェクトの別の繰返しかどうかは確認しません。マージ後、2つのオブジェクトの測定を分離することはできません。

スフィアで認識されているサービスの新しいバージョンをデプロイするときに、変更されたWSDLが登録または検出される場合、WSDLで定義されているサービスの修飾名が、そのサービスが最後に読み取られたときにWSDLで検出されたサービスの名前と一致している必要があります。一致しておらず、サービス名の変更オプション(サービス・バージョニング・ポリシー)の値が「以前のエンドポイントを置換え(測定結果をすべて失う)」である場合、Business Transaction Managementによって、以前にWSDLから読み取られたエンドポイントが削除され、現在WSDLに定義されているサービスに属する新規エンドポイントが作成されます。

WSDLで定義されているネームスペースまたはサービス名のみが変更された場合、新規エンドポイントは古いエンドポイントと同じに見えますが(同じURLとバインディング)、異なる一意のIDを持ちます。Business Transaction Managementでは、このIDを利用して測定を対応するオブジェクトと関連付けるため、IDが変更された場合は、古いエンドポイントについて収集された測定が孤立し、アクセス不可能な状態になります。更新後のWSDLで定義されているサービスおよびエンドポイントが論理的に同一の場合は、moveMeasurementsコマンドを使用して、そのサービスまたはエンドポイントの新規インカーネーションに測定を再度関連付ける必要があります。

古いエンドポイントおよびサービスはすでに削除されているため、測定の移動元である古いオブジェクトはその一意のIDで識別する必要があります。削除したサービスのIDは、次のようにスフィアのシステム・ログを確認することで判別できます。

  1. ナビゲータで、「管理」→「システム・サービス」を選択します。

  2. サマリー・ペインで「AP_Sphere_Service」を選択します。

  3. 「管理」メニューから「システム・サービス・ログを開く: AP_Sphere_Service」を選択します。

  4. 「ログ・ビューア」が表示されるので、削除されたサービスを見つけて、その「交換ID」値を確認してください。

削除されたオブジェクトに関するメタデータはスフィアで認識されないため、このコマンドで実行できる検証には制限があります。ターゲットが見つからない場合や一意に指定されていない場合、このコマンドでは何の操作も実行されません。また、指定されたIDがスフィアから削除されていない現在のオブジェクトを指している場合、測定を移動しません。

このコマンドを使用して検出の問題を解決する方法の詳細は、12.7項「検出問題の解決」を参照してください。

コマンド構文

btmcli moveMeasurements -id id -n friendlyName | -qname qname [-V version]
                        [-e endpointUrl] [-bn bindingName]
                        -s sphereUrl -l username:password
名前 ロング名 説明
-id -- 測定を移動する、削除されたエンドポイントまたはサービスのUUID。

WSDLが変更されたためにシステムでサービスまたはエンドポイントが削除された場合、UUIDを含むシステム・アラートが送信されます。そうでない場合、(前述するように)スフィア・サービスのサービス・ログを確認してIDを取得する必要があります。
-n -name 測定の移動先となるターゲット・サービスのわかりやすい名前。
-qName
測定の移動先となるターゲット・サービスの修飾名。
-V -version 測定の移動先となるターゲット・サービスのバージョン。サービスのバージョンが複数ある場合にのみ必須です。
-e -endpointUrl 測定の移動先となるターゲット・エンドポイントのURL。
-bn -bindingName ターゲット・エンドポイントのバインディング名(エンドポイントURLが一意でない場合にのみ必須です)。
-s -sphereUrl スフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、moveMeasurementsコマンドの使用方法を示します。

btmcli moveMeasurements -id 00EB2838-7E62-11DF-ABB5-27339B5EB390
                        -n MyCreditService
                        -s http://localhost:8080/btmcentral/sphere/
                        -l admin:abracadabra

btmcli moveMeasurements -id CAEAF3FF-C5A7-11DF-80D5-2DF5BB94EBDE
                     -e http://text12.myhost.com:7012/bookmart/ofder/OrderService
                     -s http://localhost:8080/btmcentral/sphere/
                     -l admin:abracadabra

10.32 putSetupData

putSetupDataコマンドを使用して、標準入力または指定の入力ファイルから設定ファイルを読み取って、指定されたシステム・サービスの設定データとして保存します。

このコマンドを使用してシステムをバックアップする方法の詳細は、12.4項「Business Transaction Managementのバックアップおよびリストア」を参照してください。

コマンド構文

btmcli putSetupData -e endpointUrl [-i inputFile] 
                    -s sphereUrl -l username:password
名前 ロング名 説明
-e -endpointUrl システム・サービスのURL。
-i -inputFile 入力の取得元となるファイルの名前。
-s -sphereUrl 読み取るデータが属するサービスがインストールされているスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、指定のエンドポイントで別のサービスの設定ファイルとして書き込まれるファイルを示します。

cat myFile | btmcli putSetupData -e myServiceEndpoint

btmcli putSetupData -e myServiceEndpoint -i myInputFile

10.33 registerDevice

registerDeviceコマンドを使用して、管理デバイスをスフィアに登録します。Business Transaction Managementでは、メッセージ・トラフィックを分析することでロード・バランシング・デバイスが存在することを推察できますが、デバイスを明示的に登録すると、デバイスのわかりやすい名前およびその他の情報を表示できるようになり、デバイスの管理インタフェースが存在する場合はアクセスできるようになります。

現在、このコマンドについて、サポートされているデバイス・タイプはハードウェアおよびソフトウェア・ロード・バランサのみで、完全にサポートされているロード・バランサはF5 BigIPのみです。

ほとんどの場合、Business Transaction Managementでは、メッセージ・トラフィックを監視し、メッセージ・ヘッダーから宛先情報を読み取って、ルーティング・エントリ・ポイントを自動的に検出してモデル化します。ただし、監視対象メッセージのHTTPホスト・ヘッダーに元の受信者(ロード・バランサ)に関する情報が含まれない場合は、ルーティング・エントリ・ポイントを手動でロード・バランサに割り当てる必要があります。また、ターゲット・エントリ・ポイントを追加してメッセージのルーティング先を示す必要もあります。これを実行するには、Business Transaction Managementの管理コンソールを使用する必要があります。詳細は、12.6項「ロード・バランサの設定」(ロード・バランサの設定)を参照してください。

複数のデバイスを登録する場合は、setDefaultLoadBalancerコマンドを使用してデフォルト・デバイスを設定できます。(新しく検出されたルーティング・エントリ・ポイントはすべて、F5ロード・バランサに属していないかぎり、デフォルト・デバイスの一部としてモデル化されます。)

デバイスを登録解除するには、管理コンソールを使用する必要があります。

コマンド構文

btmcli registerDevice -baseAddress baseAddress -fn friendlyName 
                      -vendor vendor
                      [-administratorUI administratorUI]
                      [-phaseInLifecycle DEBRECATED | deprecated 
                      | DEVELOPMENT | development |PRODUCTION | production
                      | STAGING | staging |TEST | test]
                      -deviceLogin login:password
                      -s sphereUrl -l login:password
名前 ロング名 説明
-- -baseAddress https://myf5:443/など、ロード・バランサのURLのベース・アドレス。
-fn -friendlyName ロード・バランサのわかりやすい名前。この名前は、Business Transaction Managementの管理コンソールに表示されます。
-- -vendor F5 BigIPデバイスを登録する場合は、「F5」と指定します(大文字と小文字が区別されます)。この値に設定すると、vendorフラグが使用できるようになります。

その他のタイプのロード・バランサの場合、このフラグは必須ですが、説明のみを目的として使用されます。任意の値(「F5」を除く)を指定できます。指定した値は、管理コンソールに表示されます。
-- -administratorUI F5以外のデバイスの場合、ロード・バランサのHTML管理コンソールのURL。管理コンソールではこのURLを使用して、ロード・バランサのコンソールへのリンクを表示します。

F5デバイスの場合、URLは自動的に取得されるため、このフラグは不要です。
-- -phaseInLifecycle デバイス・コンテナと、その内部に作成されるすべてのエンドポイントのライフサイクル・フェーズを指定します。有効な値は、deprecated、development、production、stagingおよびtestです。これらは大文字/小文字が区別されません。
-- -deviceLogin このフラグはF5デバイスでは必須ですが、その他のタイプのロード・バランサでは無視されます。

F5ロード・バランサのログイン資格証明の形式は、login:passwordです。Guestのユーザー・ロールで十分な権限が与えられます。

このアカウントの権限が限定されている場合、Business Transaction Managementによってデバイスで管理されるオブジェクトおよびポリシーが検出されますが、Business Transaction Managementを使用してそれらを変更できないことがあります。

CLIコマンドencryptPasswordを使用してパスワードを暗号化できます。たとえば、次に示す例のようにします。

btmcli encryptPassword -password "myPassword"
-s -sphereUrl スフィアにAP_SPHERE_URL環境変数を設定している場合を除き、必須です。

次に示す例のように、デバイスを登録するスフィアのURLを指定します。

http://mySphereHost:8080/btmcentral/sphere/

ホスト名およびポート番号を適切な値で置き換えます。このURLの末尾は必ずbtmcentral/sphere/にします。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、registerDeviceコマンドを使用してF5ロード・バランサを登録する方法を示します。

btmcli registerDevice -baseAddress https://myF5:443
                      -fn MyF5LoadBalancer
                      -vendor F5
                      -phaseInLifecycle development
                      -deviceLogin my_F5_username:my_F5_password
                      -s http://mySphereHost:1771/btmcentral/sphere/
                      -l admin:abracadabra

10.34 registerExternalContainer

registerExternalContainerコマンドを使用して、(監視対象コンテナに含まれない) 1つ以上のエントリ・ポイントのエンドポイントを、個別の外部コンテナにグループ化します。これは手動で登録されたエンドポイントでのみ必要です。コンソールでは、そのようなエンドポイントは「未割当てのエンドポイント」ノードの下に表示されます。

コンテナ間でエンドポイントを個別に移動できるコマンドは存在しないため、このコマンドを使用して、指定したベース・アドレスで始まるすべてのエンドポイントを移動する必要があります。

デフォルトでは、手動で登録されたエンドポイントはシステム・コンテナに割り当てられます。registerExternalContainerコマンドを使用すると、1つのグループとして扱い、調査するエンドポイントの外部コンテナを作成できます。たとえば、このコンテナを使用して、手動で登録されたエンドポイントの2つ以上のベース・アドレスが、同じアプリケーション・サーバー内にあるという事実をモデル化できます。

物理コンテナまたはデバイスからベース・アドレスを使用することはできませんが、-fフラグを指定すると、別の外部コンテナからベース・アドレスを使用できます。つまり、検出されたエンドポイントを外部コンテナにグループ化することはできません。

このコマンドのオプション・フラグを使用すると、コンテナのプロファイル情報に表示される情報を指定できます。この情報を更新するには、別のオプション値を指定して、このコマンドをもう一度実行します。

既存のコンテナを更新するときに、ベース・アドレス・リストの最初のエントリが変更されると、コンテナのプライマリ・ベース・アドレスも変更されます。以前コンテナに属していたベース・アドレスを省略すると、コンテナからそれらのアドレスが除外され、システム・コンテナに戻されます。

このコマンドは、このコンテナ内にエンドポイントを持つサービスの登録前でも登録後でも実行できます。

コマンド構文

btmcli registerExternalContainer -baseAddress baseAddress1 [[baseAddress2]...]
                                 [-fn friendlyName] [-vendor vendor]
                                 [-containerInfo containerInfo]
                                 [-ofName osName] [-osVersion osVersion]
                                 [-administratorUI administratorUI]
                                 [-phaseInLifecycle DEBRECATED | deprecated 
                                 | DEVELOPMENT | development  
                                 |PRODUCTION | production
                                 | STAGING | staging |TEST | test]
                                 [-caseInsensitive] [-f]
                                 -s sphereUrl -l username:password
名前 ロング名 説明
-- -baseAddress コンテナに関連付けるエンドポイントの既知のベース・アドレス。複数指定した場合、最初のアドレスがプライマリ・ベース・アドレスとみなされます。
-fn -friendlyName 新しいコンテナのわかりやすい名前。デフォルトでは、プライマリ・ベース・アドレスのhost:portです。
-- -vendor コンテナのアプリケーション・サーバー・ソフトウェアのベンダー(IBM、Oracle、Microsoftなど)。
-- -containerInfo 名前/バージョン形式で示される、コンテナのアプリケーション・サーバー・ソフトウェアの名前およびバージョン。たとえば、WebLogic Server/10.3です。
-- -osName コンテナが実行されているオペレーティング・システムの名前。たとえば、WindowsやLinuxです。
-- -osVersion コンテナが実行されているオペレーティング・システムのバージョン。例: 2003、4.3。
-- -administratorUI コンテナの管理UIにアクセスするために使用できるURL。
-- -phaseInLifecycle コンテナのライフサイクル・フェーズを指定します。
-- -caseInsensitive 設定した場合、このコンテナ内のURLが大/小文字の区別なしで比較されます。
-f -force 現在別の外部コンテナに属しているベース・アドレスを、再度関連付けるかどうかを指定します。
-s -sphereUrl コンテナを登録するスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例では、指定されたベース・アドレスを持つエンドポイントを含める外部コンテナを登録します。

btmcli registerExternalContainer 
                       -baseAddress http://my_host:1234/ http://my_host/4567/
                       -s http://my_host:1234/btmcentral/sphere/ 
                       -l admin:abracadabra

10.35 registerMonitor

registerMonitorコマンドを使用して、モニター・エージェントをスフィアに登録します。

Business Transaction Managementの一元的サービスをインストールして構成すると、追加のアプリケーション・サーバーに1つ以上のモニター・ノードをデプロイして、監視対象メッセージを処理できるようになります。追加するモニターごとに、reigsterMonitorコマンドを実行する必要があります。

Business Transaction Managementモニターをホストしているノードで別名を使用している場合は、addNodeAliasコマンドを実行して別名をスフィアに登録できます。

コマンド構文

btmcli registerMonitor -e endpointUrl [-fn friendlyName]
                       -s sphereUrl -l username:password
名前 ロング名 説明
-e -endpointUrl スフィアに登録するモニターのURLを指定します。次に例を示します。

http://localhost:8080/btmmonitor/agent/agent

ホスト名およびポート番号を適切な値で置き換えます。このURLの末尾は必ずbtmmonitor/agent/agentにします。
-fn -friendlyName 登録するモニター・エージェントのエンドポイントのわかりやすい名前。
-s -sphereUrl 必須。コンテナを登録するスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

btmcli registerMonitor -e http://localhost:8080/btmmonitor/agent/agent
                       -s sphereUrl http://localhost:8080/btmcentral/sphere/
                       -l admin:abracadabra

10.36 removeBaseAddressAlias

removeBaseAddressAliasコマンドを使用して、指定のベース・アドレスを持つエントリ・ポイントの指定された別名を削除します。

別名は、このエントリ・ポイントのみに対してローカルに定義されている必要があります。ネットワーク・ノード・レベルで定義されている別名は、removeNodeAliasコマンドを使用して削除する必要があります。

removeBaseAddressAliasコマンドを使用すると、間違った別名や古い別名をシステムから削除できます。補完的なaddBaseAddressAliasコマンドにより生成された重複アーティファクトの削除は元に戻されませんが、ベース・アドレスに関する新しい検出項目および古い別名が、再び個別のエンティティとして扱われるようになります。

このコマンドを使用して検出の問題を解決する方法の詳細は、12.7項「検出問題の解決」を参照してください。

コマンド構文

btmcli removeBaseAddressAlias -baseAddress address -alias address
                              -s sphereUrl -l username:password
名前 ロング名 説明
-- -baseAddress スフィアにある既存のエントリ・ポイントのベース・アドレス。scheme://host:port/という形式を使用します。
-alias -- 前述のエントリ・ポイントの別名として削除するベース・アドレス。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境を設定している場合、このフラグは不要です。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、removeBaseAddressAliasコマンドを示します。

btmcli -removeBaseAddressAlias http://jbujes:8080 -alias http://1.2.3.4:8080
                     -s http://localhost:8080/btmcentral/sphere/
                     -l admin:abracadabra

10.37 removeDuplicateEndpoint

removeDuplicateEndpointコマンドを使用して、指定した重複エンドポイントを削除します。

このコマンドは通常、パスは同じだが、システムで認識されなかったDNS別名が原因で異なるホスト名を持つ2つのエンドポイントをシステムが検出した場合に使用します。このコマンドを実行すると、これ以降の検出によって重複エンドポイントが再作成されないように、欠落している別名も追加されます。

重複するエンドポイントのベース・アドレスのみが異なっている場合、それら両方のベース・アドレスで見つかるその他のエンドポイントも重複とみなされます。さらに、重複するエンドポイントのサービス記述子(WSDL)もモデルから削除されます。重複するエントリ・ポイントの下にある、実際には重複ではないWSDLおよびエンドポイントは削除されず、残りのエントリ・ポイント下に移動されます。

指定されたエンドポイントURLが依存性を検出済のエンドポイントを参照し、重複するURLが検出または手動で登録されたエンドポイントを参照している場合、コマンドは無効になります。重複するエンドポイントは維持され、エンドポイントURLのベース・アドレスが別名として扱われます。

このコマンドで定義する変更をコミットする前に、コマンドの結果をプレビューできます。プレビュー後、実際に変更を実行するには、-Pオプションを指定せずにもう一度コマンドを実行する必要があります。

このコマンドを使用して検出の問題を解決する方法の詳細は、12.7項「検出問題の解決」を参照してください。

コマンド構文

btmcli removeDuplicateEndpoint -e endpointUrl -d duplicateUrl [-P]
                               -s sphereUrl -l username:password
名前 ロング名 説明
-e -endpointUrl 維持するエンドポイントのURL。
-d -duplicateUrl 重複として削除するエンドポイントのURL。
-P -preview 実際にエンドポイントを移動することなく、移動の結果をプレビューします。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

重複を削除する別の方法

次のような状況では、モデルの整合性が損なわれたり、実際には重複していない情報が破棄されないようにするために、removeDuplicateEndpointコマンドでは指定された変更を実行しません。

  • エンドポイントが、同じサービスの別のサービスまたは別のバージョンに属している場合。

  • エンドポイントにより異なるインタフェースが実装される場合。

  • エンドポイントが異なるデプロイメントに存在する場合。

  • 重複するエンドポイントのWSDLが、残りのエンドポイントについてはWSDLにより参照されていないサービスまたはエンドポイントを参照している場合(つまり、WSDLが重複とはみなされない場合)。

このような場合、次の手順の実行が必要になることあります。

  1. unregisterコマンドを使用して、removeDuplicateEndpointコマンドでは削除できないサービス・エンドポイントの登録を解除します。

  2. addNodeAliasまたはaddBaseAddressAliasコマンドを使用して別名を追加し、システムでエンドポイントの重複を認識できるようにします。

例

次の例に、removeDuplicateEndpointコマンドを示します。

btmcli removeDuplicateEndpoint 
              -e http://jbujes.edge.com:7001/bookmart/credit/CreditService
              -d http://jbujes.delphi.com:7001/bookmart/credit/CreditService -P
              -s http://localhost:8080/btmcentral/sphere/
              -l admin:password

10.38 removeNode

removeNodeコマンドを使用して、指定したノードに関する情報をスフィア・データベースから削除します。ノードを削除すると、そのノードに関するすべての情報が別名を含めて削除されます。

ノードの削除は、様々なマシンの別名が混在しているために、ノードをプルーニングするかシステムを再インストールするかという選択に直面している場合を除いて、通常必要ない操作です。ほとんどの場合(誤ったホスト・ファイルを修正する場合や、別のマシンを指すようにDNS別名を変更する場合)、実行する必要があるのは、あるノードから別名を削除して、それを別のノードに追加しなおすことのみです。

コマンド構文

btmcli removeNode -n nodeName -alias aliasName
                  -s sphereUrl -l username:password
名前 ロング名 説明
-n -name ネットワーク・ノードの正規名。通常は完全修飾ドメイン名です。たとえば、jbujes-myPC.edgility.comです。
-f -force ノードがまだコンテナまたはエントリ・ポイントにより参照されている場合でも、強制的にノードを削除します。

このノードを削除する前に別のネットワーク・ノードにノードの別名を割り当てた場合、コンテナ自体が別のノードに関連付けられるようにすることができます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、removeNodeコマンドを示します。

btmcli removeNode -n jbujes.edge.com
                  -s http://localhost:8080/btmcentral/sphere/
                  -l username:password

10.39 removeNodeAlias

removeNodeAliasコマンドを使用して、別名情報をスフィア・データベースから削除します。

このコマンドを使用して検出の問題を解決する方法の詳細は、12.7項「検出問題の解決」を参照してください。

コマンド構文

btmcli removeNodeAlias -n nodeName -alias aliasName
                       -s sphereUrl -l username:password
名前 ロング名 説明
-n -name ネットワーク・ノードの正規名。通常は完全修飾ドメイン名です。たとえば、jbujes-myPC.edgility.comです。
-alias -alias ネットワーク・ノードの別名。これには、ドメイン名または静的IPアドレスを指定できます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、removeNodeAliasコマンドを示します。

btmcli removeNodeAlias -n jbujes.edge.com -alias Athena
                       -s http://localhost:8080/btmcentral/sphere/
                       -l admin:abracadabra

10.40 removePathAlias

removePathAliasコマンドを使用して、指定したWSDLまたはエンドポイントにアクセスするために使用できる代替URLパスを表す別名を削除します。これ以降の登録や検出では、2つのパスが別々のものとして扱われます。

ホスト名の別名についてはremoveNodeAlias、WSDLのURLのオーソリティにおける他の別名についてはremoveBaseAddressAliasも参照してください。

removePathAliasコマンドを使用すると、古い別名をシステムから削除できます。たとえば、HTTPリダイレクトによってサービス記述子に追加された別名が後から無効にされた場合(WSDLのURL AがURL Bにリダイレクトされたが、現在2つのURLは異なるWSDLを表している場合)、このコマンドによって別名が削除され、WSDL Aを個別に登録できるようになります。

このコマンドを使用して検出の問題を解決する方法の詳細は、12.7項「検出問題の解決」を参照してください。

コマンド構文

ap removePathAlias -w wsdlUrl| -e endpointUrl -alias pathAlias
                   -s sphereUrl -l username:password
名前 ロング名 説明
-w -wsdlUrl 別名を削除する完全URLまたはWSDL (サービス記述子)。
-e -endpointUrl 別名を削除するエンドポイントの完全URL。複数のエンドポイントが一致する場合、それらすべてのエンドポイントから別名が削除されます。
-alias -- サービス記述子またはエンドポイントから削除する代替パス。これは、/で始まるURLのパス部分のみです。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、暗号化されたパスワードを使用するremovePathAliasコマンドを示します。

btmcli removePathAlias -e http://jbujes:7001/credit/CreditService 
                       -alias /bookmart/amex/CreditSrevice 
                       -s http://localhost:8080/btmcentral/sphere/ 
                       -l admin:abracadabra

10.41 removePolicy

removePolicyコマンドを使用して、適用されているポリシーをBusiness Transaction Managementシステムから完全に削除します。

コマンド構文

btmcli removePolicy -name PlcyName [-type PlcyType] [-subType PlcySubType]
                    [-version PlcyVersion] [-wait true|false] [-f] 
                    -s sphereUrl -l username:password

ポリシーのタイプおよびサブタイプを判断するには、ナビゲータで「ポリシー」を選択します。各ポリシーのタイプおよびサブタイプが、メイン・ペインに表示されます。

名前 ロング名 説明
-n -name 削除するポリシーの名前。この名前が一意の場合、追加のタイプまたはバージョン情報を指定する必要はありません。
-t -type 削除するポリシーのポリシー・タイプ。ポリシー名が一意でない場合はこのフラグを使用します。
-subType -- 削除するポリシーのポリシー・サブタイプ。

名前とタイプの組合せが一意でない場合は、ポリシー・サブタイプを指定します。
-V -version 削除するポリシーに関連付けられているバージョン。

名前、タイプおよびサブタイプのトリプルが一意でない場合は、バージョン番号を指定します。バージョン番号は、一意のポリシーを作成するために、ポリシー名に自動的に付加されます。
-wait -- TRUE: ポリシーが削除されるまで、別のスクリプトの実行を待機します。

デフォルト値は、FALSEです。
-f -force ポリシーが内部的に削除不可とマークされている場合でも、ポリシーを削除します。
-s -sphereUrl ポリシーが適用されるスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例では、myLoggingPolicyというポリシーをスフィアから削除し、ポリシーが削除されるまで他のコマンドの実行を待機します。

btmcli removePolicy -name myLoggingPolicy -wait true 
                    -s http://localhost:8080/btmcentral/sphere/
                    -l admin:abracadabra

10.42 removePolicyTemplate

removePolicyTemplateコマンドは、指定されたポリシー・テンプレートをシステムから削除します。

コマンド構文

btmcli removePolicy -name PolTemplName [-type Type] [-subType SubType] 
                   [-version PolicyVersion] [-f] 
                   -s sphereUrl -l username:password

ポリシー・テンプレートのタイプおよびサブタイプを判断するには、ナビゲータで「ポリシー・テンプレート」を選択します。各ポリシーのタイプおよびサブタイプが、メイン・ペインに表示されます。

名前 ロング名 説明
-name -- 削除するポリシー・テンプレートの名前。この名前が一意の場合、追加のタイプまたはバージョン情報を指定する必要はありません。
-type -- 削除するポリシー・テンプレートのポリシー・タイプ。ポリシー名が一意でない場合はこのフラグを使用します。
-subType -- 削除するポリシー・テンプレートのポリシー・サブタイプ。

名前とタイプの組合せが一意でない場合は、ポリシー・サブタイプを指定します。
-version -- 削除するポリシーに関連付けられているバージョン。

名前、タイプおよびサブタイプのトリプルが一意でない場合は、バージョン番号を指定します。バージョン番号は、一意のポリシーを作成するために、ポリシー名に自動的に付加されます。
-f -force ポリシー・テンプレートが内部的に削除不可とマークされている場合でも、ポリシー・テンプレートを削除します。
-s -sphereUrl ポリシーが適用されるスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例では、myPolicyTemplateというポリシー・テンプレートをスフィアから削除します。

btmcli removePolicyTemplate -name myPolicyTemplate
                            -s http://localhost:8080/btmcentral/sphere/
                            -l admin:abracadabra

10.43 renameEndpoint

renameEndpintコマンドを使用して、スフィアでの指定されたエンドポイントのわかりやすい名前を変更します。

同じURLにある複数のエンドポイントに、それぞれのWSDL定義で同じ名前が指定されている場合、それらに一意のわかりやすい名前を指定すると、それ以降のコマンドおよびコマンド出力でそれらのエンドポイントを区別しやすくなります。エンドポイントURLおよび新規のわかりやすい名前を指定する必要があります。その他すべてのパラメータはオプションであり、対象のエンドポイントを、同じURLを持つ他のエンドポイントと区別できるようにするためにのみ使用します。

このコマンドを使用して検出の問題を解決する方法の詳細は、12.7項「検出問題の解決」を参照してください。

コマンド構文

btmcli renameEndpoint -e endpointUrl -fn friendlyName [-bn bindingName]
                      [-w wsdlUrl] [-n name] [-service serviceName] 
                      [-qname qname] [-V version] [-interfaceQName interfaceQName]
                      -s sphereUrl -l username:password
名前 ロング名 説明
-e -- WebサービスのエンドポイントURL。
-bn -bindingName エンドポイントのバインディング。複数のバインディングを持つエンドポイントURLを明確化するために使用します。例: SOAPおよびHTTP
-w -wsdlUrl WSDLファイルのURL。
-n -name 名前を変更するエンドポイントの既存のわかりやすい名前。
-service -- 名前が変更されたエンドポイントが属するサービスのわかりやすい名前。
-qname -- 名前が変更されたエンドポイントが属するサービスの修飾名。
-V -version 名前が変更されたエンドポイントが属するサービスのバージョン。必要に応じて、-serviceまたは-qnameフラグとともに使用します。

デフォルトの未指定バージョンを表すには、-文字列を使用します。
-- -interfaceQName 名前が変更されたエンドポイントが実装するインタフェースの修飾名。
-fn -friendlyName 名前を変更するエンドポイントの新規のわかりやすい名前。
-s -sphereUrl スフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、renameEndpointコマンドを使用して、CreditServiceという名前をMyCreditServiceに変更する方法を示します。

btmcli renameEndpoint -e http://jbujes:7001/bookmart/credit/CreditService
                      -fn MyCreditService
                      -s http://localhost:8080/btmcentral/sphere
                      -l admin:abracadabra

10.44 resetSphereUrl

resetSphereUrlコマンドを使用して、このスフィアに現在登録されているコンテナ・サービスのスフィアURLが、現在のスフィアURLに一致していることを確認します。このコマンドを使用する必要があるのは、スフィアのベース・アドレスが変わったときです。

コマンド構文

btmcli resetSphereUrl -s sphereUrl -l username:password
名前 ロング名 説明
-s -sphereUrl スフィアのURL。

http://hostname:port/apcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、resetSphereUrlコマンドを示します。

btmcli resetSphereUrl -s http://localhost:8080/btmcentral/sphere/
                      -l admin:abracadabra

10.45 retrieveObjectData

retrieveObjectDataコマンドは、1つ以上のオブジェクトのプロファイルおよび測定データを取得します。このコマンドの出力ファイルは、次の方法で使用できます。

  • レポート作成ツールへの入力。

Business Transaction ManagementにはOracle BI Publisherテンプレートが用意されており、これをコマンドの出力ファイルとともに使用して、書式設定されたレポートを生成できます。これらのテンプレートの使用の詳細は、第9章「レポートの作成」を参照してください。

  • setBaseLinesコマンドへの入力。

この場合、retrieveObjectDataの出力ファイルをsetBaselinesへの入力ファイルとして使用して、オブジェクト・セットのパフォーマンス・ベースライン値を設定します。ベースラインを設定すると、ベースラインSLAポリシーを作成できるようになります(出力ファイルを使用してベースラインを設定する場合、retrieveObjectDataコマンドの属性は設定しないでください)。

コマンド構文

btmcli retrieveObjectdata -t type1 [[type2] ...] [-query filterQuery]
           [-attributeNames attrName1 [attrName2] ... instrName1 [instrName2] ...]
           [-segments segment1 [segment2] ...] 
           [-inTheLast inTheLast] | [-startTime startTime] [-endTime endTime]
           [-intervalSize intervalSize] 
           [-format XML|CSV|SQL] 
           [-o outputFile] 
           [-metadata drop|create|none] [-tableName tableName] 
           -s sphereUrl -l username:password

listInstrumentsコマンドを使用して、retrieveObjectDataコマンドに引数として渡す必要がある属性、セグメントおよびインスツルメントに関する情報を取得できます。属性のリストおよびセグメントのリストを指定すると、コマンド・パーサーによって、各セグメントが、属性リスト内のそのセグメントを持つすべてのインスツルメントに適用されます。

時間値を指定しない場合は、単一セグメントで最後の時間のデータが取得されます。

名前 ロング名 説明
-t -type 取得するデータが属するオブジェクト・ツリーを指定します。

少なくともルート・オブジェクト・タイプを指定する必要があり、それによって取得されるオブジェクトが(問合せとともに)決定されます。

これに加えて、任意の数の子タイプも指定できます。これらのツリーには、カスタム・データ・エクスプローラで検出されたものも反映されます。タイプ・ツリーの例は、service endpoint operationまたはobserver probe endpointです。
-query -filterQuery 取得するオブジェクトを、問合せフィルタで定義されたセットに限定します。

問合せは、ツリーのルート・オブジェクト・タイプに適用する必要があります。指定された問合せに一致するオブジェクトのみが、サブツリーの関連オブジェクトとともに結果セットで返されます。

フィルタ・ツールを使用してAQL問合せを作成し、それらの問合せをコピーしてコマンドラインに貼り付けます。
-- -attributeNames この引数を使用して、次の例のように、各オブジェクトで取得する属性およびインスツルメント値を指定します。

-attributeNames friendlyName averageResponseTime

この例では、friendlyNameが属性、averageResponseTimeがインスツルメントです。複数の属性名(スペースで区切る)に続けて、複数のインスツルメント名(スペースで区切る)を指定できます。

属性名は、列チューザで使用可能な任意の属性を参照できます。属性は、次の例に示すように、オブジェクト・タイプの後に2つのコロン(::)を付けたもので修飾できます。

Endpoint::friendlyName

修飾属性名を指定した場合、指定されたオブジェクト・タイプのみについて属性値が取得されます(この例では、エンドポイントのわかりやすい名前のみです)。未修飾属性名を指定した場合、属性値は、type引数で示されているすべてのオブジェクト・タイプのうち、その属性を持つものについて取得されます(たとえば、エンドポイント、サービスおよび操作)。よく使用される属性名およびオブジェクト・タイプの完全なリストは、10.1.6項「属性名」を参照してください

インスツルメント名の完全なリストを表示するには、listInstrumentsコマンドを実行してください。
-segments -- 指定された測定属性(インスツルメント)のデータを取得するときに使用するセグメントを指定します。これにより、指定された時間範囲に記録された名前付きセグメントの値ごとに、データの内訳が示されます。
-inTheLast -- 現在時刻から、指定した時間だけ過去にさかのぼった時間範囲を指定します。

値は、数値の後に単位を付けて指定します(sまたはSは秒、mまたはMは分、hまたはHは時間、dまたはDは日) (たとえば、1Hは1時間です)。
-startTime -- 測定属性(インスツルメント)が指定されている場合に、その値を生成する時間範囲の開始時刻を指定します。endTimeを指定しない場合、範囲の終了は現在時刻になります。

現在のデフォルト日付書式が使用されます(たとえば、2010-08-03 15:00:00です)。
-endTime -- 測定属性(インスツルメント)が指定されている場合に、その値を取得する時間範囲の終了時刻を指定します。

現在のデフォルト日付書式が使用されます(たとえば、2010-08-03 18:00:00です)。
-- -intervalSize 指定した時間範囲を分割する間隔サイズを指定します。

間隔サイズは、数値の後に単位を付けて指定します(sまたはSは秒、mまたはMは分、hまたはHは時間、dまたはDは日) (たとえば、1Hは1時間です)。間隔サイズは、指定された時間範囲の長さ以下である必要があります。

このオプションの引数を指定しない場合は時間範囲全体が使用され、1つの間隔のみが返されます。

注意: 出力ファイルをsetBaselinesコマンドの入力として使用する場合は、この属性を設定しないでください。setBaselinesコマンドでは、各オブジェクトのインスツルメント・タイプ当たり1つの値しか受け入れません。この属性を省略することで、必ず各オブジェクトのインスツルメント・タイプ当たり1つの値のみが出力されるようになります。
-format -- 出力ファイルの形式を指定します。有効な値は、XML、CSVおよびSQLです。XMLがデフォルトの形式です。
-o -outputFile 出力ファイルの名前。
-metadata -- SQLメタデータ・コマンドを作成するかどうかを指定します。

有効な値は、表を削除して作成する場合にはdrop、表の作成のみの場合にはcreateです。
-tablename -- SQL出力に使用されるSQL表名を指定し、指定しない場合は名前が生成されます。
-s -sphereUrl スフィアのURL。たとえば、http://hostname:port/btmcentral/sphere/です。

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例1: コンテナのデータの取得。

btmcli retrieveObjectData
         -t container
         -s http://myHost:7003/btmcentral/sphere/
         -l my_sphere_username:my_sphere_password
         - my_containers_output.xml

例2: レポートのための各サービスの平均レスポンス時間の取得(-intervalSizeが指定されていることに注意してください)。

btmcli retrieveObjectData
         -t service
         -s http://my_host:7003/btmcentral/sphere/
          -l my_sphere_username:my_sphere_password
          -attributeNames firendlyName averageResponseTime
          -inTheLast 24h
          -intervalSize 1h
          -format xml
          -o my_avg_response_time_output_for_reporting.xml

例3: 各サービス、エンドポイントおよび操作のベースラインの設定における平均レスポンス時間の取得(-intervalSizeが指定されていないことに注意してください)。

btmcli retrieveObjectdata
          -t service endpoint operation
          -s http://my_host:7003/btmcentral/sphere/
          -l my_sphere_username:my_sphere_password
          -attributeNames friendlyName averageResponseTime
          -inTheLast 24h
          -o my_avg_response_time_output_for_baselines.xml

10.46 sendEventNotification

sendEventNotificationコマンドを使用して、通知サービスを使用してイベント通知を作成および送信します。通知の処理方法は、現在アクティブなサブスクリプションによって決定されます。

次のいずれかの状況が発生した場合、システムにより自動的にアラートが生成されます。

  • SLA施行ポリシーによって、失敗アラート、警告アラートまたはコンプライアンス・アラートが発行された場合。

  • 条件定義によって、トランザクション監視サービスから条件アラートが発行された場合。

  • システム・サービスによってスローされた例外が原因で、システムからシステム・アラートが発行された場合。

これらの場合に加えて、管理者が、メンテナンスやアップグレードのためにシステムを停止する必要があることをユーザーに通知したり、なんらかの管理操作により、レポート作成に使用されたデータが再生成されることをユーザーに通知するためのアラートを発行する必要がある場合があります。このような通知を可能にするために、sendEventNotificationコマンドが用意されています(sendToNotifierコマンドを使用してイベント通知を送信することもできますが、作業量が大きく増えます)。

コマンド構文

btmcli sendEventNotification -source source -n name
                   -topic topic [-subtopic subtopic] 
                   -severity SEVERE | WARNING | INFO | CONFIG | FAILURE | SUCCESS 
                   -message message
                   [-attributes name1:value1 [[name2:value2] ...]] 
                   -s sphereUrl -l username:password
名前 ロング名 説明
-source -- 通知が生成された場所を示します。指定可能なソースには、ASLM、ExMおよびSystemが含まれます。任意の値を指定できます。
-n -name イベント通知に関連付けられる名前。これは、イベントが何に関するものであるかの情報を示す必要があります。
-topic -- イベント通知のトピック。類似のイベント通知の分類に使用します。
-subtopic -- イベント通知のサブトピック。イベント通知の分類に使用します。
-- -severity 通知の原因となった状況の重要性を示します。
-message -- イベント通知の意味とユーザー・アクションの必要性に関するテキスト説明。
-- -attributes イベント通知に添付され、通知を受信するどのユーザーでも使用できるようになっているname:valueペアのリスト。これらの属性は通常、通知に関係するオブジェクトを参照します。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、sendEventNotificationコマンドを使用して、システムのバックアップが間もなく行われることを現在のサブスクライバに通知する方法を示します。

btmcli sendEventNotification -source System -n BackupWarning 
               -topic SysNotifications -severity WARNING
               -message "System backup in 10 minutes. Please save your work."
               -s http://localhost:8080/btmcentral/sphere/
               -l admin:abracadabra

10.47 sendToNotifier

sendToNotifierコマンドを使用して、電子メールおよびWebサービスのサブスクリプションを管理できます。

sendToNotifierコマンドは、(XML入力ファイルで指定される)コマンドを処理のために通知サービスに送信します。電子メール・サブスクリプションの作成、既存のサブスクリプションのリスト、サブスクリプションの削除などを実行できます。このコマンドは、通知サービスによって返されるレスポンス・ドキュメントを返します。追加のコマンドを発行するには、別のコマンドを含む入力ファイルを指定して、sendToNotifierをもう一度コールする必要があります。

sendToNotifierのコマンド構文はかなり単純ですが、入力コマンド・ドキュメントの作成は複雑になる場合があります。

Business Transaction Managementでは現在、コマンドライン・インタフェースを介した電子メールおよびWebサービスのサブスクリプションのみをサポートしています。

この項の最後に説明するコマンド・ドキュメントには、次のいずれかのタスクを実行するxmlメッセージ(コマンド)を含めることができます。

  • 電子メール・サブスクリプションの作成

  • Webサービスで通知操作をコールするためのサブスクリプションの作成

  • 既存のサブスクリプションのリスト

  • 通知サービスからのサブスクリプションの削除

コマンド構文

btmcli sendToNotifier -i inputFile [-o outputFile] 
                      -s sphereUrl -l username:password
名前 ロング名 説明
-i -inputFile 通知サービスに送信するコマンドを含むXMLファイル。ファイルごとに1つのコマンドを含めることができます。
-o -outputFile 通知サービスからのレスポンスを保持するファイル。指定しない場合、レスポンスはstdoutに送信されます。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

10.47.1 電子メール通知の設定

sendToNotifierの使用は、電子メール通知を設定する際の1つのステップです。全体的な手順には次のステップも含まれます。

  1. ナビゲータから「システム・サービス」を選択し、「サマリー」領域に示されているサービスから「AP_Notifier_Service」を選択します。

  2. 使用するメール・ホストおよび電子メール送信者を指定するように(「管理」メニューで)設定データを編集します。

  3. sendToNotifierコマンドを使用して、SLAアラート、条件アラートなどへのサブスクリプションを登録します(入力コマンド・ドキュメントに、必要なアラートを指定するコマンドを含めます)。たとえば、次のドキュメントは条件アラートに対するサブスクリプションを登録します。

    <ap:registerSubscription
   soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 <ap:subscription name="All Exception Alerts" enabled="true" userID="testID">
    <ap:deliveryMechanism> 
      <ap:sendEmail format="long" style="html">
           <ap:from>BTM.TEST@oracle.com</ap:from> 
           <ap:recipient type="TO">your.name@yourdomain.com</ap:recipient> 
      </ap:sendEmail> 
  </ap:deliveryMechanism> 
  <ap:notificationFilters> 
      <ap:source> 
           <ap:value>ExM</ap:value> 
           <ap:operation>in</ap:operation> 
      </ap:source> 
   </ap:notificationFilters> 
  </ap:subscription> 
 </ap:registerSubscription>

    入力コマンド・ドキュメントについては、10.47.3項「通知サービス・コマンド・ドキュメント」で説明します。

  4. 対象オブジェクトのSLAまたは条件アラートを定義します。

10.47.2 電子メール通知の管理

sendToNotifierを使用して、サブスクリプションをリストおよび削除することもできます。この方法を示すサンプル・コマンド・ドキュメントを次に示します。

サブスクリプションをリストするには

<ap:getSubscription xmlns:ap="http://namespace.amberpoint.com/amf"/>

サブスクリプションを取り消すには

<ap:cancelSubscription xmlns:ap="http://namespace.amberpoint.com/amf">
 <ap:subscription name="All Exception Alerts" userID="testID"/>
 <ap:subscription name="All SLA Alerts" userID="testID"/>
 <ap:subscription name="All System Alerts" userID="testID"/>
</ap:cancelSubscription>

例

次の例に、sendToNotifierコマンドを示します。

btmcli sendToNotifier -i MyNotifierCommand -o MyNotifierReponse 
               -s http://localhost:8080/btmcentral/sphere -l admin:abracadabra

10.47.3 通知サービス・コマンド・ドキュメント

通知サービス・コマンド(xmlメッセージ)は、sendToNotifierコマンドへの入力であるコマンド・ドキュメントに含めることができます。通知サービス・コマンドについては次の各項で説明しますが、これらを使用して、次の操作を実行できます。

  • 電子メール・サブスクリプションの作成

  • Webサービス・サブスクリプションの作成

  • サブスクリプションのリスト

  • サブスクリプションの削除

  • 通知対象の取得

  • テンプレートの取得

各ドキュメントに含めることができるコマンドは1つのみです。複数のコマンドを実行するには、コマンドごとにドキュメントを作成し、各ドキュメントに対してsendToNotifierコマンドを呼び出す必要があります。

10.47.3.1 通知サービス・コマンド

次の各項では、通知サービス・ドキュメントに含めることができるコマンドについて説明します。

電子メール・サブスクリプションの作成

このコマンドでは、次のバリエーションがサポートされます。

  • 特定のタイプ(たとえば、システム・アラート、SLAアラート、条件アラート)のすべてのアラートに対するサブスクリプションの作成

  • 特定のオブジェクト(たとえば、トランザクション、サービス、エンドポイント、操作、コンシューマ、システム・サービス)に関するすべてのアラートに対するサブスクリプションの作成

  • 特定の重大度(たとえば、失敗および警告。ただしコンプライアンスおよび情報アラートは除く)のすべてのアラートに対するサブスクリプションの作成

  • 特定のポリシーにより生成されたすべてのアラート(たとえば、ベースラインSLAポリシーにより生成されたすべてのアラート)に対するサブスクリプションの作成

  • 特定の条件により生成されたすべてのアラート(たとえば、FaultMonitoring条件に対するすべての条件アラート)に対するサブスクリプションの作成

次のサンプル・コマンドに加えて、アラート・タイプを指定するために使用するメタデータについても理解している必要があります。これについては次の項で説明します。

<ap:registerSubscription xmlns:ap="http://namespace.amberpoint.com/amf"
                xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
                xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
                xmlns:xsd="http://www.w3.org/1999/XMLSchema"
                soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 <ap:subscription name="All SLA Alerts" enabled="true" userID="testID">
   <ap:deliveryMechanism>
         <ap:sendEmail format="short" style="text">
           <ap:from>BTM.TEST@oracle.com</ap:from>
           <ap:recipient type="TO">your.email@oracle.com</ap:recipient>
         </ap:sendEmail>
   </ap:deliveryMechanism>
   <ap:notificationFilters>
         <ap:source>
           <ap:value>ASLM</ap:value>
           <ap:operation>in</ap:operation>
         </ap:source>
   </ap:notificationFilters>
 </ap:subscription>
</ap:registerSubscription>

次に、コメント付きの詳細な例を示します。

<ap:registerSubscription xmlns:ap="http://namespace.amberpoint.com/amf"
             xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
             xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
             xmlns:xsd="http://www.w3.org/1999/XMLSchema"
             soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 <ap:subscription name="Warning and Failure SLA Alerts" enabled="true"
                                                          userID="testID">
    <ap:deliveryMechanism>
      <ap:sendEmail format="long" style="html">
        <ap:from>BTM.TEST@oracle.com</ap:from>
        <ap:recipient type="TO">your.name@oracle.com</ap:recipient>
      </ap:sendEmail>
    </ap:deliveryMechanism>
    <ap:notificationFilters>
     <ap:source>
        <ap:value>ASLM</ap:value><!-- subcribe to SLA alerts -->
        <ap:operation>in</ap:operation>
     </ap:source>
     <ap:severity>
      <ap:value>WARNING</ap:value> <!-- subcribe to WARNING and FAILURE alerts -->
      <ap:value>FAILURE</ap:value>
      <ap:operation>in</ap:operation>
     </ap:severity>
    </ap:notificationFilters>
 </ap:subscription>
 <ap:subscription name="Exception Alert transaction OrderService_submit"
                                           enabled="true" userID="testID">
 <ap:deliveryMechanism>
   <ap:sendEmail format="short" style="text">
      <ap:from>BTM.TEST@oracle.com</ap:from>
      <ap:recipient type="TO">your.name@oracle.com</ap:recipient>
   </ap:sendEmail>
 </ap:deliveryMechanism>
 <ap:notificationFilters>
     <ap:event>
      <ap:value>Exception Detected</ap:value> <!-- subscribe to Exception alert
                                                                  event-->
      <ap:operation>in</ap:operation>
     </ap:event>
   <ap:info>
     <ap:name>correlationName</ap:name> <!-- subcribe to tx by friendly name-->
     <ap:value>OrderService_submit</ap:value>
     <ap:operation>in</ap:operation>
   </ap:info>
  </ap:notificationFilters>
 </ap:subscription>
</ap:registerSubscription>

Webサービス・サブスクリプションの作成

このコマンドでは、次のバリエーションがサポートされます。

  • 特定のタイプ(たとえば、システム・アラート、SLAアラート、条件アラート)のすべてのアラートに対するサブスクリプションの作成

  • 特定のオブジェクト(たとえば、トランザクション、サービス、エンドポイント、操作、コンシューマ、システム・サービス)に関するすべてのアラートに対するサブスクリプションの作成

  • 特定の重大度(たとえば、失敗および警告。ただしコンプライアンスおよび情報アラートは除く)のすべてのアラートに対するサブスクリプションの作成

  • 特定のポリシーにより生成されたすべてのアラート(たとえば、ベースラインSLAポリシーにより生成されたすべてのアラート)に対するサブスクリプションの作成

  • 特定の条件により生成されたすべてのアラート(たとえば、FaultMonitoring条件に対するすべての条件アラート)に対するサブスクリプションの作成

<ap:registerSubscription xmlns:ap="http://namespace.amberpoint.com/amf"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/1999/XMLSchema"
    soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
       <ap:subscription name="Dispatch" enabled="true" userID="ABC">
         <ap:deliveryMechanism>
           <ap:callWebService>
              <ap:httpEndPoint>
            <ap:uri>http://10.148.118.72:8080/eProxy/svc/NotifPort_Proxy</ap:uri>
                   <!-- this is my test webService, replace with your own.-->
         <ap:soapAction>ReplaceWithRealSoapActionForDotNetService</ap:soapAction>
              </ap:httpEndPoint>
           </ap:callWebService>
         </ap:deliveryMechanism>
         <ap:notificationFilters>
            <ap:source>
                           <ap:value>ASLM</ap:value>
                           <ap:value>ExM</ap:value>
                           <ap:value>System</ap:value>
                           <ap:operation>in</ap:operation>
           </ap:source>
        </ap:notificationFilters>
    </ap:subscription>
 </ap:registerSubscription>

サブスクリプションの取得

このコマンドでは、次のバリエーションがサポートされます。

  • すべての電子メール・サブスクリプションのリスト

  • すべてのWebサービス・サブスクリプションのリスト

  • 特定の電子メール・アドレスに対するすべてのサブスクリプションのリスト

  • 特定のWebサービスに対するすべてのWebサービス・サブスクリプションのリスト

  • 特定のオブジェクト(トランザクション、サービス、エンドポイント、操作、システム・サービス、コンシューマ)に対するすべてのサブスクリプションのリスト

これらのアクションの例を次に示します。

すべてのサブスクリプションの取得

<ap:getSubscription xmlns:ap="http://namespace.amberpoint.com/amf"/>

サブスクリプション名によるサブスクリプションの取得

<ap:getSubscription xmlns:ap="http://namespace.amberpoint.com/amf">
         <ap:subscription name="Dispatch"/>
</ap:getSubscription>

ユーザー名によるサブスクリプションの取得

<ap:getSubscription xmlns:ap="http://namespace.amberpoint.com/amf">
    <ap:subscription userID="mary"/> 
</ap:getSubscription>

サブスクリプションの取消

このコマンドでは、次のバリエーションがサポートされます。

  • 特定の電子メール・アドレスに対するすべてのサブスクリプションの削除

  • 特定のWebサービスに対するすべてのWebサービス・サブスクリプションの削除

  • 特定のオブジェクト(たとえば、トランザクション、サービス、エンドポイント、操作、システム・サービス、コンシューマ)に関するすべてのサブスクリプションの削除

次に例を示します。

<ap:cancelSubscription xmlns:ap="http://namespace.amberpoint.com/amf">
          <ap:subscription name="Dispatch" userID="mary"/> </ap:cancelSubscription>

形式情報の取得

このコマンドは、ロングHTMLやショート・テキストといった使用可能な形式を返します。コマンドのサンプル出力を次に示します。

<ap:getFormatInformationResponse xmlns:ap="http://namespace.amberpoint.com/amf"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> 
 <ap:for value="Email" xmlns:ap= "http://namespace.amberpoint.com/amf">
   <ap:format value="long"xmlns:ap="http://namespace.amberpoint.com/amf"/> 
   <ap:format value="short" xmlns:ap="http://namespace.amberpoint.com/amf"/>
   <ap:style value="html" xmlns:ap="http://namespace.amberpoint.com/amf"/> 
   <ap:style value="text" xmlns:ap="http://namespace.amberpoint.com/amf"/> 
  </ap:for> 
</ap:getFormatInformationResponse

通知対象の取得

次のようなコマンドを使用します。

<ap:getNotificationInterest xmlns:ap="http://namespace.amberpoint.com/amf"/>

テンプレートの取得

次のようなコマンドを使用します。

<ap:getTemplate/>

10.47.3.2 アラート・タイプのメタデータ

SLA、例外およびシステム・アラートのメタデータを理解している必要があります。この情報は、特定のタイプの情報に対するサブスクリプションを適切に書式設定するために使用します。次の表に、メタデータ情報を示します。

SLAアラートのメタデータ

次の表に、SLAアラートのメタデータを示します。

メタデータ 使用可能な値 サンプル・サブスクリプション
(ヘッダー) source ASLM 
<ap:notificationFilters> 
  <ap:source> 
   <ap:value>ASLM</ap:value>
   <ap:operation>in</ap:operation> 
  </ap:source> 
</ap:notificationFilters>
(ヘッダー) event enforcement_condition 
<ap:notificationFilters> 
   <ap:event> 
      <ap:value>enforcement_condition</ap:value> 
      <ap:operation>in</ap:operation> 
   </ap:event> 
</ap:notificationFilters>
(ヘッダー) severity WARNING

FAILURE

SUCCESS

INFO

 
<ap:notificationFilters> 
   <ap:severity>
      <ap:value>WARNING,FAILURE</ap:value>
      <ap:operation>in</ap:operation> 
   </ap:severity> 
</ap:notificationFilters>
(ヘッダー) templateSet ASLM-Template 
<ap:notificationFilters> 
   <ap:templateSet>
      <ap:value>ASLM-Template</ap:value>
      <ap:operation>in</ap:operation>
    </ap:templateSet> 
</ap:notificationFilters>
(info) com.amberpoint.notification.enforcementValue (アラートをトリガーしたSLA施行の値) 
<ap:notificationFilters> 
  <ap:info> 
     <ap:name>com.amberpoint.notification.
                         instrumentName</ap:name>
     <ap:value>85</ap:value>
     <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.instrument

名前

 (インスツルメントの修飾名) 表の後に示す注意を参照。
(info) com.amberpoint.notification.objectType Service、Endpoint、Transaction 
<ap:notificationFilters> 
  <ap:info>
    <ap:name>com.amberpoint.notification.
                            objectType</ap:name> 
    <ap:value>Service</ap:value> 
    <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.objectId (SLAポリシーが適用されるオブジェクトのUUID) 
<ap:notificationFilters> 
  <ap:info>
    <ap:name>com.amberpoint.notification.
                            objectId</ap:name>
    <ap:value>uuid:DA936829-98FF-11DF-828B-
                      A3EAF532919E</ap:value>
    <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.policyId (SLAポリシーのUUID) 
<ap:notificationFilters> 
  <ap:info> 
    <ap:name>com.amberpoint.notification.
                                policyId</ap:name>
    <ap:value>uuid:896FCF93-9900-11DF-8753-
                           57E6CFA43E9B</ap:value>
    <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.senderId (AP_Enforcer_ServiceのUUID) 
<ap:notificationFilters> 
  <ap:info>
     <ap:name>com.amberpoint.notification.
                              senderId</ap:name>
     <ap:value>uuid:896FCF93-9900-11DF-8753-
                         57E6CFA43E9B</ap:value>
     <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.senderUrl (AP_Enforcer_Serviceの場所) 
<ap:notificationFilters> 
  <ap:info> 
     <ap:name>com.amberpoint.notification.
                              senderUrl</ap:name>
     <ap:value>http://localhost:8080/
                btmperformance/endorcer</ap:value>
     <ap:operation>in</ap:operation> 
   </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.transaction

Id

 トランザクションのUUID (SLAがトランザクションに適用されている場合のみ) 
<ap:notificationFilters> 
  <ap:info>
      <ap:name>com.amberpoint.notification.
                          transactionId</ap:name>
      <ap:value>uuid:896FCF93-9900-11DF-8753
                          -57E6CFA43E9B</ap:value>
      <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>
(info) endpointId (AP_Enforcer_Serviceシステム・エンドポイントのUUID) 
<ap:notificationFilters> 
  <ap:info>
    <ap:name>com.amberpoint.notification.
                              endpointId</ap:name>
    <ap:value>uuid:896FCF93-9900-11DF-8753-
                           57E6CFA43E9B</ap:value>
    <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>
(info) serviceID (AP_Enforcer_ServiceのUUID) 
<ap:notificationFilters> 
  <ap:info>
     <ap:name>com.amberpoint.notification.
                               serviceId</ap:name>
     <ap:value>uuid:896FCF93-9900-11DF-8753-
                           57E6CFA43E9B</ap:value>
     <ap:operation>in</ap:operation>
  </ap:info> 
<ap:notificationFilters>

(info) com.amberpoint.notification.instrumentNameのサンプル・サブスクリプションを次に示します。

<ap:notificationFilters> 
  <ap:info> 
     <ap:name>com.amberpoint.notification.instrumentName</ap:name>
     <ap:value>http://schemas.amberpoint.com/instruments/transactions/
                                      types:startedTransactionCount</ap:value> 
     <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>

条件アラートのメタデータ

次の表に、条件アラートのメタデータを示します。

メタデータ 使用可能な値 サンプル・サブスクリプション
(ヘッダー) source ExM 
<ap:notificationFilters> 
  <ap:source> 
     <ap:value>ExM</ap:value> 
     <ap:operation>in</ap:operation> 
  </ap:source> 
</ap:notificationFilters>
(ヘッダー) event Exception Detected 
<ap:notificationFilters> 
  <ap:event> 
    <ap:value>Exception Detected</ap:value>
    <ap:operation>in</ap:operation> 
  </ap:event> 
</ap:notificationFilters>
(ヘッダー) severity FAILURE、

WARNING、

INFO

 
<ap:notificationFilters> 
  <ap:severity> 
    <ap:value>WARNING</ap:value>
    <ap:operation>in</ap:operation> 
  </ap:severity> 
</ap:notificationFilters>
(ヘッダー) templateSet Exm-Template 
<ap:notificationFilters> 
  <ap:templateSet> 
     <ap:value>Exm-Template</ap:value>
     <ap:operation>in</ap:operation> 
  </ap:templateSet> 
</ap:notificationFilters>
(info) com.amberpoint.notification.objectType Transaction 
<ap:notificationFilters> 
  <ap:info>
   <ap:name>com.amberpoint.notification.objectType</ap:name>
   <ap:value>Transaction</ap:value>
   <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.objectId (トランザクションのUUID) 
<ap:notificationFilters> 
 <ap:info>
  <ap:name>com.amberpoint.notification.objectId</ap:name>
  <ap:value>uuid:896FCF93-9900-11DF-8753-57E6CFA43E9B
                                          </ap:value>
  <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.transactionId (トランザクションのUUID) 
<ap:notificationFilters> 
 <ap:info>
  <ap:name>com.amberpoint.notification.transactionId</ap:name>
  <ap:value>uuid:896FCF93-9900-11DF-8753-57E6CFA43E9B
                                                   </ap:value>
  <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>
(info) correlationName (関数のわかりやすい名前) 
<ap:notificationFilters> 
 <ap:info> 
   <ap:name>correlationName</ap:name>
   <ap:value>testTransaction1</ap:value>
   <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>
(info) detectionTime (解読可能なタイムスタンプ。例: Thu Jul 22 12:25:49 PDT 2010) 
<ap:notificationFilters> 
 <ap:info> 
   <ap:name>detectionTime</ap:name> 
   <ap:value>Thu Jul 22 12:25:49 PDT 2010</ap:value>
   <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>
(info) exceptionPriority failure、warning、informational 
<ap:notificationFilters>  
 <ap:info> 
   <ap:name>exceptionPriority</ap:name>
   <ap:value>warning</ap:value>
   <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>
(info) exceptionTemplate (条件のわかりやすい名前) 
<ap:notificationFilters> 
  <ap:info> 
    <ap:name>exceptionTemplate</ap:name>
    <ap:value>condition2</ap:value>
    <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>
(info) exceptionType (トランザクション名+条件名またはサービス名+条件名) 
<ap:notificationFilters> 
 <ap:info> 
   <ap:name>exceptionType</ap:name>
   <ap:value>testTransaction1+condition2</ap:value>
   <ap:operation>in</ap:operation> 
 </ap:info> <ap:notificationFilters>
(info) exceptionsURL (例外インスタンスのUIページに戻るリンクのURL) 
<ap:notificationFilters> 
 <ap:info> 
   <ap:name>exceptionsURL</ap:name>
   <ap:value>http://localhost:8080/btmui</ap:value>
   <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>
(info) instanceID (例外インスタンスのUUID) 
<ap:notificationFilters> 
 <ap:info> 
   <ap:name>instanceId</ap:name>
   <ap:value>uuid:896FCF93-9900-11DF-8753-57E6CFA43E9B
                                              </ap:value> 
   <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>

システム・アラートのメタデータ

次の表に、システム・アラートのメタデータを示します。

メタデータ 使用可能な値 サンプル・サブスクリプション
(ヘッダー) source System 
<ap:notificationFilters> 
  <ap:source> 
     <ap:value>System</ap:value> 
     <ap:operation>in</ap:operation> 
  </ap:source> 
</ap:notificationFilters>
(ヘッダー) event business_object_creation 
<ap:notificationFilters> 
  <ap:event> 
     <ap:value>business_object_creation</ap:value>
     <ap:operation>in</ap:operation> 
  </ap:event> 
</ap:notificationFilters>
(ヘッダー) severity INFO 
<ap:notificationFilters> 
   <ap:severity> 
      <ap:value>INFO</ap:value> 
      <ap:operation>in</ap:operation> 
   </ap:severity> 
</ap:notificationFilters>
(ヘッダー) templateSet System-Template 
<ap:notificationFilters> 
   <ap:templateSet> 
     <ap:value>System-Template</ap:value>
     <ap:operation>in</ap:operation> 
   </ap:templateSet> 
</ap:notificationFilters>
(info) com.amberpoint.notification.senderId (このアラートを送信するサービスのUUID。) 
<ap:notificationFilters> 
 <ap:info> 
  <ap:name>com.amberpoint.notification.senderId</ap:name> 
  <ap:value>uuid:896FCF93-9900-11DF-8753-57E6CFA43E9B</ap:value>
  <ap:operation>in</ap:operation> 
 </ap:info> 
<ap:notificationFilters>
(info) com.amberpoint.notification.senderUrl (このアラートを送信するサービスの場所。) 
<ap:notificationFilters> 
  <ap:info>
    <ap:name>com.amberpoint.notification.senderUrl</ap:name>
    <ap:value>http://localhost:8080/btmperformance/endorcer
                                                  </ap:value> 
    <ap:operation>in</ap:operation> 
  </ap:info> 
<ap:notificationFilters>

10.48 setBaselines

setBaselinesコマンドは、指定されたオブジェクトのベースラインを設定します。ベースラインを設定すると、ベースラインSLAポリシーを作成できるようになります

retrieveObjectDataコマンドを使用して、履歴パフォーマンス・データを取得してファイルに出力でき、このファイルをsetBaselinesコマンドへの入力として使用できます。入力ファイルを手動で作成する場合は、retrieveObjectDataコマンドの出力と同じ形式を使用してください。

このコマンドを使用して、指定したオブジェクトまたはすべての管理対象オブジェクトの既存のベースラインを削除することもできます。

コマンド構文

btmcli setBaselines -i inputFile [-delete] [-all] 
                    -s sphereUrl -l username:password
名前 ロング名 説明
-i -- サービス、サービス操作、エンドポイント、エンドポイント操作およびトランザクションのベースライン値を示すXMLドキュメント。ベースライン・サービス・レベル合意に使用できるベースライン値(SLAは、履歴から導出されたパフォーマンスしきい値に基づきます)。
-delete -- 新しいベースラインを設定する前に、参照されている管理対象オブジェクトの既存のベースラインをすべて削除します。
-all -- -deleteオプションと組み合せて使用し、すべての管理対象オブジェクトの既存ベースラインをすべて削除します。この場合、入力ファイルは不要です。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、setBaselinesコマンドを示します。

btmcli setBaselines -i MyBookmartBaselines -delete
            -s http://mySphereHost:1771/btmcentral/sphere/ 
            -l my_btm_admin_username:my_btmadmin_password

10.49 setDefaultLoadBalancer

setDefaultLoadBalancerコマンドを使用して、監視対象メッセージ・トラフィックから検出されたルーティング・エントリ・ポイントのモデル化に使用するデフォルト・デバイスを設定します。

既知のロード・バランサが1つのみの単純な環境では、そのデバイスが自動的にデフォルトとして使用されます。追加のデバイスを登録した場合は、このコマンドを使用して、ルーティング・エントリ・ポイントのモデリングにどのデバイスを使用するかを設定します。

ロード・バランサおよびそのデフォルトの設定方法の詳細は、12.6項「ロード・バランサの設定」を参照してください。

コマンド構文

btmcli setDefaultLoadBalancer -baseAddress baseAddress | -fn friendlyName
                              -s sphereURL -l username:password
名前 ロング名 説明
-- -baseAddress ロード・バランサのURLのベース・アドレス。たとえば、https://myf5:443/です。
-fn -- スフィアでのロード・バランサのわかりやすい名前。この名前は、ナビゲータから「デバイス」を選択したときにサマリー・ペインに表示されます。これは、ロード・バランサの登録時にユーザーが割り当てた名前です。
-s -sphereUrl 必須。コンテナを登録するスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例では、デフォルトのルーティング・デバイスを指定します。

btmcli setDefaultLoadBalancer -baseAddress https://myF5:443/ 
                 -s http://localhost:8080/btmcentral/sphere -l admin:abracadabra

10.50 showService

showServiceコマンドを使用して、サービスのわかりやすい名前、修飾名または任意のエンドポイントのURLで指定したサービスの構造を示します。サービスの1つのバージョンを指定したり(-version)、より詳細な情報を表示するように指定することもできます(-verbose)。

非詳細出力には、バージョン番号、サービスの修飾名、わかりやすい名前、バインディング、管理対象および完全URLが含まれます。

コマンド構文

btmcli showService -n friendlyName  | -qname qname| -e endpointUrl 
                                                               | -wwsdlUrl
                   [-V version] [-v] 
                   -s sphereUrl -l username:password
名前 ロング名 説明
-n -name 情報を検索する対象となるサービスのわかりやすい名前。この名前は、-versionフラグを使用して修飾できます。そうしない場合、このわかりやすい名前を持つすべてのサービスに関する情報が表示されます。
-qname -- 情報を検索する対象となるサービスの修飾名。修飾名の形式はWSDLtargetNamespace:serviceNameです。たとえば、http://amberpoint.com/orderService:CreditServiceSOAPです。
-e -endpointUrl サービスの任意のエンドポイントのURL。この場所にあるエンドポイントが複数のサービスで定義されている場合、それらすべてのサービスに関する情報が表示されます。
-w -wsdlUrl 1つ以上のサービス・エンドポイントを定義するWSDLファイルのURL。
-V -version 情報を表示するサービスのバージョン。

デフォルトの未指定バージョンを表すには、-文字列を使用します。
-v -verbose 各エンドポイントの追加情報を表示します。
-s -sphereUrl スフィアのURL。http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

次に、サンプル・コマンドの出力を示します。

btmcli showService -n OrderService

OrderService (Version -)
QName: http://amberpoint.com/orderService:OrderService

   Name: OrderServiceSOAP  Binding: SOAP/HTTP   Managed by: Monitored by Observer
   http://islam.us.oracle.com:7412/bookmart/order/OrderSerrvice


btmcli showService -qname http://schemas.amberpoint.com/sphere:SphereService 

AP_Sphere_Service (Version 7.0.0.0-ExM-Hegemony)
QName: http://schemas.amberpoint.com/sphere:SphereService

   Name: AP_Sphere_Service_SOAP Binding: SOAP/HTTP 
                                      Managed by: AmberPoint AP_Core_Service
   http://islam.us.oracle.com:8080/btmcentral/sphere/

例

次の例では、showServiceコマンドを使用して、指定されたwsdlで定義されるサービスの情報を表示します。

btmcli showService 
  -w http://jbujes-desk.edgility.com:7001/bookmart/credit/CreditService?wsdl 
  -s http://localhost:8080/btmcentral/sphere -l admin:abracadabra

10.51 unmonitorEndpoint

unmonitorEndpointコマンドを使用して、指定されたエンドポイントが登録されているモニター・エージェントによる、そのエンドポイントの監視を停止するために使用します。

監視が停止すると、パフォーマンス測定は記録されず、メッセージはログに記録されず、トランザクションはトレースされません。

監視を再度有効にするには、monitorEndpointコマンドを使用します。

コマンド構文

btmcli unmonitorEndpoint -n name | -e endpointUrl1 [[endpointUrl2] ...] 
                         -s sphereUrl -l username:password
名前 ロング名 説明
-n -name 監視を停止するエンドポイントのわかりやすい名前。
-e -endpointUrl 監視を停止するエンドポイントのエンドポイントURLのリスト。

これがWebサービスの場合は、エンドポイントにアクセスする実際のURLを指定できます。それ以外のタイプのコンポーネントの場合は、管理コンソールの「プロファイル」タブを確認して、エンドポイントのURLを特定してください。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例に、unmonitorEndpointコマンドを使用してMyEndpointの監視を停止する方法を示します。

btmcli unmonitorEndpoint -n MyEndpoint 
                         -s http://localhost:8080/btmcentral/sphere/ 
                         -l Admin:abracadabra

10.52 unregister

unregisterコマンドを使用して、サービス、WSDLまたはエンドポイントをスフィアから登録解除します。

  • -wまたは-nオプションを使用して登録解除したサービスごとに、登録解除された項目に関する情報が次の形式で出力されます。

    WSDL_URL:serviceFriendlyName

  • -eおよび-interfaceQNameオプションを使用して登録解除したエンドポイントごとに、登録解除された項目に関する情報が次の形式で出力されます。

    endpointUrl:endpointBinding

登録解除する項目がスフィアに登録されていない場合、このコマンドでは出力が生成されません。

特定のエンドポイントを登録解除するには、そのエンドポイントが属するサービスを-nまたは-qnameフラグを使用して指定し、登録解除するエンドポイントをendpointUrlおよび-interfaceQNameフラグを使用して指定します。一般的にこのオプションは、依存性検出済エンドポイントが正しく作成されなかった場合に役立ちます。-interfaceQNameフラグを指定しない場合、依存性検出済エンドポイントのみが登録解除されます。

サービス名またはWSDL URLを指定して、1つのWSDLファイルのエンドポイントで構成される重複サービスを登録解除する場合も、同じ動作になります。複数のWSDLファイルのエンドポイントで構成される重複サービスを登録解除する場合は、サービスの指定方法によって異なる動作になります。

  • サービスがわかりやすい名前または修飾名で指定されている場合、サービス全体が登録解除されます。

  • WSDLが-wsdlUrlフラグにより指定されている場合、そのWSDLのエンドポイントのみが登録解除されます。その他のWSDLから検出されたエンドポイントは影響を受けません。

サービスまたはエンドポイントを登録解除すると、その履歴にアクセスできなくなります。サービスまたはエンドポイントを再登録して、その履歴にアクセスする可能性がある場合は、そのUUIDを保存する必要があります(「プロファイル」タブに示されています)。

コマンド構文

btmcli unregister -n serviceName | -qname qualifiedName | -w wsdlUrl1
                                                  [[wsdlUrl2...]
           [-V version] [-e endpointUrl] [-interfaceQName interfaceQName] [-f]
           -s sphereUrl -l username:password
名前 ロング名 説明
-n -name スフィアから削除するサービスのわかりやすい名前。

名前が一意でない場合は、-V (version)フラグを使用して修飾する必要があります。
-qname -- スフィアから削除するサービスの修飾名(WSDL targetNamespaceにサービス名を追加したもの)。

このオプションは、異なる修飾名を持つ複数のサービスに、同じわかりやすい名前がスフィアで割り当てられている場合に役立ちます。

名前が一意でない場合は、-V (version)フラグを使用して修飾する必要があります。
-w -wsdlUrl 登録解除するサービスを持つWDSLファイルのURL。

このコマンドでは、-wまたは-nフラグのいずれか1つを指定する必要があります。
-V -version 登録解除するサービスのバージョン。-qnameまたは-nameオプションとあわせて使用する必要があります。

デフォルトの未指定バージョンを表すには、-文字列を使用します。
-e -- 特定のエンドポイントのURL。この場合、対応するWSDLは登録解除されません。

-interfaceQName 登録解除する特定のエンドポイントのインタフェースの修飾名。
-f -force サービスのエンドポイントが監視されていても、そのサービスを登録解除します。監視は、サービスを登録解除する前に停止されます。
-s -sphereUrl WSDLがインストールされているスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例では、指定されたwsdl内のサービスを登録解除します。

btmcli unregister -w http://myProductionBox:28006/OrderService.wsdl 
                  -s http://mydomain.com/btmcentral/sphere/ -l Admin:abracadabra

10.53 unregisterContainer

unregisterContainerコマンドを使用して、以前Business Transaction Managementに登録したコンテナを登録解除します。このコマンドは、コンテナが完全にオフラインになった後に使用してください。このコマンドを使用してコンテナを登録解除した方が、コンテナに含まれる各エンドポイントを登録解除するよりも短時間で完了します。

物理コンテナは、システムが停止状態とマークするまで十分に長い時間オフラインにしてから登録解除してください。

このコマンドによって、コンテナ内のすべてのシステム・サービス、サービス記述子およびエンドポイントも登録解除されます。コンテナ内のすべての監視対象エンドポイントは監視されなくなり、これらのエンドポイントの測定は削除されます。

コマンド構文

btmcli unregisterContainer -baseAddress baseAddress | -fn friendlyName 
                           -s sphereURL -l username:password
名前 ロング名 説明
-i -baseAddress スフィアにある既存のエントリ・ポイントのベース・アドレス。

ベース・アドレスの形式: scheme://host:port/
-fn -friendlyName 登録解除するコンテナのわかりやすい名前。わかりやすい名前が一意でない場合、かわりにbaseAddressオプションを使用する必要があります。
-s -sphereUrl 必須。登録解除するコンテナ内に存在するスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次のコマンドは、MyAppsというわかりやすい名前を持つコンテナを登録解除します。

btmcli 
btmcli unregisterContainer -fn MyApps 
                           -s http://localhost:8080/btmcentral/sphere/ 
                           -l admin:abracadabra

10.54 unregisterMonitor

unregisterMonitorコマンドを使用して、指定したモニターをスフィアから登録解除します。

このコマンドは、モニターが完全にオフラインになっているときにのみ使用してください。モニターは、システムが停止状態とマークするまで十分に長い時間オフラインにしてから登録解除してください。

モニター・エージェントを登録解除すると、次のような影響があります。

  • そのモニターに関連付けられているすべての監視対象エンドポイントの監視が停止されます。

  • 監視が停止されたエンドポイントの測定が失われます。このコマンドは、モニターが完全にオフラインになっているときにのみ使用してください。

コマンド構文

btmcli unregisterMonitor -baseAddress address  | -fn friendlyName
                         - s sphereUrl -l username:password
名前 ロング名 説明
-- -baseAddress スフィア内のモニターのベース・アドレス。次に例を示します。

http://localhost:8080/btmmonitor/agent/agent
-fn -friendlyName 登録解除するモニター・エージェントのわかりやすい名前。

わかりやすい名前が一意でない場合、かわりに-baseAddressオプションを使用する必要があります。
-s -sphereUrl WSDLがインストールされているスフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

例

次の例では、指定されたベース・アドレスを持つモニターを登録解除します。

btmcli unregisterMonitor -base address
                               http://localhost:8080/btmmonitor/agent/agent 
              -s http://mydomain.com/btmcentral/sphere/ -l admin:abracadabra

10.55 updateProfileData

updateProfileDataコマンドを使用して、指定されたオブジェクト・セットのプロファイル属性データを更新使用します。このコマンドは既存オブジェクトのみを更新し、指定されたオブジェクトを見つけることができない場合はエラーを返します。

このコマンドは、次に示す特定の2つの状況で役立ちます。

  • オブジェクトのコレクションを、属性値の共通セットで更新する必要がある場合。たとえば、一連のサービスのアプリケーション・グループを同じ値に設定する場合です。

  • オブジェクトのコレクションの属性値を、それぞれ別の値に設定する必要がある場合。たとえば、外部データ・ソースから取得したデータをインポートする場合です。

詳細は、後述の説明を参照してください。

コマンド構文

btmcli updateProfileData -t type [-query filterQuery] 
          [-val name1:val1 [[name2:val2]...]]] | [-profileData profileData]
         -s sphereUrl -l username:password
名前 ロング名 説明
-t -type 更新するオブジェクトのタイプ。
-query -filterQuery 問合せに一致するオブジェクト・セットを選択します。

フィルタ・ツールを使用してAQL問合せを作成し、それらの問合せをコピーしてコマンドラインに貼り付けます。
-val -attributeValues 選択したオブジェクトを更新するために使用するname:valueペアのリスト。リスト内の各エントリは、属性の名前と値を示します。

この引数を指定する場合は、-query引数も指定する必要があります。

よく使用される属性名およびオブジェクト・タイプの完全なリストは、「属性名」の項を参照してください。
-- -profileData 更新するプロファイル・データを含むファイルの名前を指定します。このファイルには、指定したフラグに応じて、2つの形式のうちのいずれかを設定できます。

-query引数を指定した場合、ファイルはJavaプロパティ・ファイルで、各エントリは属性名とそれに対応する値です。

-query引数を指定しない場合、このファイルはcsv形式のテキスト・ファイルで、最初の行に更新する属性を指定し、それ以降の行にオブジェクト・インスタンスの値を指定します。更新されるオブジェクトを識別するために、キー属性を含める必要があります(オブジェクトIDまたはそのタイプのナチュラル・キーを構成する属性)。
-s -sphereUrl スフィアのURL。

http://hostname:port/btmcentral/sphere/

スフィアにAP_SPHERE_URL環境変数を設定している場合、このフラグは必要ありません。
-l -userLogin スフィアに関連付けられているユーザー名とパスワード。形式はusername:passwordです。この資格証明セットは、btmadminロールのユーザーに属している必要があります。

ログイン資格証明の設定の詳細は、10.1.3項「CLIコマンドにアクセスする場合のセキュリティ・オプション」を参照してください。

encryptPasswordコマンドを使用してパスワードを暗号化できます。

説明

このコマンドは、基本的に次の3つの形式で使用します。

  • オブジェクト・セットについて、1つ以上の属性を同じ値に更新する場合は、次の形式を使用します。

    updateProfileData -t myType -query myQuery -val attr1=valueattr2=value ...

    または次の形式を使用します。

    updateProfileData -t myType -query myQuery -profileData javaPropFile

  • 各オブジェクトの属性値がそれぞれ異なるオブジェクト・セットをバルク更新する場合(外部データベースから更新する場合など)は、次の形式を使用します。

updateProfileData -t myType -profileData CSVFile_with_1_row_per_Object_to_update

例

次の例に、updateProfileコマンドを示します。

btmcli updateProfileData -t endpoint -profileData MyJavaPropertyFile 
          -s http://localhost:8080/btmcentral/sphere/ -l Admin:abracadabra
  前
前 		 次
次
  目次へ移動
目次		 索引へ移動
索引