メトリック拡張を使用すると、Oracleのモニタリング機能を拡張してIT環境に固有の条件をモニターできるようになります。これにより、環境の包括的な情報を把握できます。さらに、メトリック拡張では、他のモニタリング・ツールを使用してこの補足的なモニタリングを提供するかわりに、データセンター全体でEnterprise Managerを単一の集中モニタリング・ツールとして使用することによって、IT組織の運用プロセスを簡略化できます。
この章の内容は次のとおりです。
メトリック拡張によって、どのタイプのターゲットでもメトリックを作成できます。ユーザー定義メトリック(以前のEnterprise Managerリリースでモニタリングを拡張するために使用された)とは異なり、メトリック拡張では、次のような多数のターゲット・タイプに対して本格的なメトリックを作成できます。
ホスト
データベース
Fusion Applications
IBM Websphere
Oracle Exadataデータベースおよびストレージ・サーバー
Siebelコンポーネント
Oracle Business Intelligenceコンポーネント
メトリック拡張は「メトリック拡張」ページで管理します。このページでは、すべてのメトリック拡張がリストされるだけでなく、メトリック拡張を作成、編集、インポート/エクスポートおよびデプロイできます。
メトリック拡張はOracle Integration Adapterに基づいています。アダプタは、特定のプロトコルを使用して、ターゲットに関するデータの収集手段を提供します。アダプタが使用できるかどうかは、メトリック拡張でモニターするターゲットのタイプによって異なります。
メトリック拡張とユーザー定義メトリックの違い
Enterprise Managerの以前のリリースでは、ユーザー定義メトリックを使用してモニタリング機能を拡張していましたが、制限がありました。OSスクリプトの実行によるポイント値の収集や、SQLによる少し複雑な値セット(オブジェクトごとに1つ)の収集を行うことができました。メトリック拡張とは異なり、ユーザー定義メトリックには次のような制限がありました。
統合の制限: OSまたはSQLのユーザー定義メトリックが、カスタム・スクリプトまたは必須の追加依存ファイルを実行する場合、ユーザーはそれらのファイルをターゲットのファイル・システムに手動で転送する必要がありました。
問合せプロトコルの適用制限: OSユーザー定義メトリックは、メトリックから複数の行を返して、サーバーの子オブジェクトをモデル化することができません(この機能はSQLユーザー定義メトリック専用です)。
データ収集の制限: 正規のEnterprise Managerメトリックは、1つの問合せで複数のデータを収集でき、関連するデータをアラート・コンテキストに反映することができます。ただし、ユーザー定義のメトリックの場合は、複数のユーザー定義メトリックを作成することによって、データの複数のピースを収集する必要があります。データは個別に収集されているため、アラートの生成時に関連付けられたデータを参照することはできません。
問合せプロトコルの制限: ユーザー定義メトリックで使用できるのはOSプロトコルとSQLプロトコルのみです。メトリック拡張では、SNMPやJMXなど、その他のプロトコルも使用できます。
ターゲット・アプリケーションの制限: ユーザー定義メトリックで作成できるのは、ホスト・ターゲットにはOSユーザー定義メトリック、データベース・ターゲットにはSQLユーザー定義メトリックのみです。その他のターゲット・タイプには対応していません。たとえば、ご使用の環境でWebLogicインスタンスに対してユーザー定義メトリックをデプロイしようとしても、それはホスト・ターゲット・タイプでもデータベース・ターゲット・タイプでもないため、デプロイできません。
メトリック拡張とユーザー定義メトリックの最も重要な違いは、メトリック拡張はユーザー定義メトリックとは異なり、Enterprise Managerに用意されているメトリックと同じ本格的なメトリックであるということです。これらは、Enterprise Manager提供のメトリックと同じく、Enterprise Managerのすべてのモニタリング機能で操作および公開できます。また、導入されるすべての新機能に自動的に適用されます。
メトリック拡張の開発は、プログラミングによるカスタマイズでは常に必要となる次の3つのフェーズで構成されます。
メトリック拡張の開発
メトリック拡張のテスト
メトリック拡張のデプロイおよび公開
メトリック拡張の開発
最初の手順では、モニタリング要件を定義します。ここで、ターゲット・タイプ、収集する必要があるデータ、そのデータを収集するために使用できるメカニズム(アダプタ)、さらに資格証明の昇格が必要かどうかを決定します。これらの決定を行うと、メトリック拡張を開発する準備が整います。Enterprise Managerでは、順を追って作成プロセスを進められる直観的なユーザー・インタフェースが提供されます。
メトリック拡張ウィザードでは、自由に編集できる形式で、メトリック拡張の開発と調整を行うことができます。また、選択したターゲットに対してメトリック拡張を対話的にテストできることが重要です。専用のテスト環境にメトリック拡張をあらかじめデプロイする必要はありません。「テスト」ページで、リアルタイムのメトリック評価を実行して、スクリプトまたはメトリック拡張定義に構文エラーがないことを確認できます。
メトリック拡張の作業が終了したら、「終了」をクリックしてウィザードを終了します。新たに作成されたメトリック拡張が、「メトリック拡張ライブラリ」に表示され、ここで、さらに編集するためにメトリック拡張にアクセスしたり、複数のターゲットに対してテストできるデプロイ可能な下書きとして保存できます。
注意:
メトリック拡張を編集できるのは、ステータスが「編集可能」の場合のみです。メトリック拡張をデプロイ可能な下書きとして一度保存すると、新たに編集を加えるには新しいバージョンを作成する必要があります。
メトリック拡張のテスト
リアルタイム・ターゲット・テストで、予期していたデータがメトリック拡張から返されたら、メトリック拡張をターゲットに対してデプロイし、データ収集を開始することで、Enterprise Managerで堅牢性と実際の動作をテストすることができます。この時点では、メトリック拡張はまだプライベート(開発者のみがターゲットにデプロイ可能)ですが、動作の点ではOracleの即時利用可能なメトリックと同じです。この手順には、ライブラリでの編集可能なメトリック拡張の選択とデプロイ可能ドラフトの生成が含まれます。
ここで、「ターゲットにデプロイ」アクションを進めて、メトリック拡張を実際のターゲットにデプロイできます。ターゲットにデプロイすると、返されるメトリック・データを確認し、アラート通知をテストできます。前に説明したように、デプロイ可能な下書きを作成するとメトリック拡張の編集はできなくなります。新しいバージョンのメトリック拡張を作成する必要があります。
メトリック拡張のデプロイ
複数のメトリック拡張バージョンやターゲット・デプロイメントを使用して綿密にテストした後で、メトリック拡張を本番環境にデプロイできるようになります。この時点まで、メトリック拡張は作成者にしか表示されません。Enterprise Managerのすべての管理者がアクセスできるようにするには、公開する必要があります。「アクション」メニューから、「メトリック拡張の公開」を選択します。
メトリック拡張を公開したら、予定していた本番ターゲットにデプロイすることができます。少数のターゲットをモニタリングしている場合は、「ターゲットにデプロイ」メニュー・オプションを選択し、一度に1つずつターゲットを追加します。ターゲット数が多い場合は、モニタリング・テンプレートを使用してメトリック拡張をターゲットにデプロイします。メトリック拡張は、正規のメトリックと同じ方法でモニタリング・テンプレートに追加します。その後、モニタリング・テンプレートをターゲットにデプロイします。
注意:
公開していないメトリック拡張をモニタリング・テンプレートに追加することはできません。追加しようとすると、モニタリング・テンプレートのページに警告が表示され、そのメトリック拡張を削除しないと操作を続けることができません。
メトリック拡張の更新
Enterprise Managerリリース12.1.0.4以上では、Enterprise Managerの自己更新機能を使用してメトリック拡張を更新できます。詳細は、「Cloud Controlの更新」を参照してください。
ほとんどのメトリック拡張操作は、「メトリック拡張」ホームページで実行できます。公開された拡張の操作をこのUIの外部から実行する必要がある場合、Enterprise MangerによってEM CLI動詞も提供されており、アーカイブ・ファイルに対するメトリック拡張のインポート/エクスポートや従来のユーザー定義メトリックのメトリック拡張への移行などの操作を行うことができます。ここでは、UIの外部で実行するメトリック拡張の操作について説明します。
メトリック拡張の作成、編集、表示、デプロイまたはアンデプロイを行うには、要件となる管理者権限が必要です。Enterprise Manager管理者に必要な権限は次のとおりです。
メトリック拡張の作成: 次のシステム・レベルのアクセス件:
管理者がメトリック拡張を表示およびデプロイできます。
管理者が拡張を編集および削除できます。
メトリック拡張の編集: 「メトリック拡張の作成」権限を持つユーザーが、特定のメトリック拡張の次のバージョンを編集および作成できます。メトリック拡張の作成者にはデフォルトでこの権限があります。この権限はメトリック拡張ごとに付与される必要があります。
完全なメトリック拡張: 「メトリック拡張の作成」権限を持つユーザーが、特定のメトリック拡張の新しいバージョンを編集および作成できます。
メトリックの管理: ユーザーがターゲットに対して拡張をデプロイおよびアンデプロイできます。
注意: 「メトリックの管理」権限は、ターゲット単位で付与する必要があります。
「メトリック拡張の作成」権限を他の管理者に付与する手順:
別の管理者が作成したメトリック拡張を編集または削除するには、Enterprise Manager管理者に適切なアクセス権が付与されている必要があります。「編集」権限では、次のバージョンの拡張の編集および作成が可能です。「完全」権限では、前述の拡張の操作と削除が可能です。
既存のメトリック拡張に対する「編集」または「完全」アクセス権を、他の管理者に付与するには:
一般に、管理者はIT環境内のターゲットのモニタリングと管理の責任を共有します。そのため、メトリック拡張の作成と保守は、複数の管理者が関与する共同作業になります。メトリック拡張の管理者はメトリック拡張UIからアクセスを直接制御できます。
メトリック拡張の所有者またはスーパー管理者は、次のアクションを実行し、別の管理者に割り当てられたメトリック拡張の権限を取り消します。
Enterprise Managerは、メトリック拡張の所有権を、現在の所有者から、「メトリック拡張の作成」権限が付与されている別の管理者に転送することができます。
注意:
Enterprise Managerのスーパー管理者は、すべてのメトリック拡張に対する完全な管理上のアクセス権を持ちます(表示、編集および所有権の転送)。
前述のとおり、「アクセスの管理」は拡張の所有者またはEnterprise Managerのスーパー・ユーザーに対してのみ使用可能になります。所有権が転送されると、前の所有者は、所有権の転送前に明示的に付与されていないかぎり、メトリック拡張でのどんな管理権限もなくなります。「所有者の変更」オプションはユーザーにのみ使用可能で、ロールには使用できません。
「アクセスの管理」により、メトリック拡張の所有者またはスーパー管理者は別のEnterprise Managerユーザーまたはロールに、メトリック拡張の編集、変更、または削除の機能を付与できます。
Enterprise Managerは、メトリック拡張の所有権を、現在の所有者から、「メトリック拡張の作成」権限が付与されている別の管理者に転送することができます。
注意:
Enterprise Managerのスーパー管理者は、すべてのメトリック拡張に対する完全な管理上のアクセス権を持ちます(表示、編集および所有権の転送)。
前述のとおり、「アクセスの管理」は拡張の所有者またはEnterprise Managerのスーパー・ユーザーに対してのみ使用可能になります。所有権が転送されると、前の所有者は、所有権の転送前に明示的に付与されていないかぎり、メトリック拡張でのどんな管理権限もなくなります。「所有者の変更」オプションはユーザーにのみ使用可能で、ロールには使用できません。
「アクセスの管理」により、メトリック拡張の所有者またはスーパー管理者は別のEnterprise Managerユーザーまたはロールに、メトリック拡張の編集、変更、または削除の機能を付与できます。
既存のメトリック拡張に基づいて新しいメトリック拡張を作成するには:
既存のメトリック拡張を編集するには、編集しようとする拡張に対して編集権限が必要です。または、拡張の作成者であることが必要です。注意: メトリック拡張をデプロイ可能な下書きとして保存した後は、編集はできなくなり、新しいバージョンを作成することしかできません。
既存のメトリック拡張を編集するには:
既存のメトリック拡張の新バージョンを作成するには、新バージョンを作成しようとする拡張に対して編集権限が必要です。または、拡張の作成者であることが必要です。
既存のメトリック拡張の新バージョンを作成するには:
メトリック拡張は、ポータブルな自己完結型パッケージに変換できるので、メトリック拡張を他のEnterprise Managerインストール環境やストレージ/バックアップに移動することが可能です。このパッケージをメトリック拡張アーカイブ(MEA)ファイルと言います。
MEAはzipファイルで、メトリック拡張を構成するすべてのコンポーネント、すなわちメトリック・メタデータ、コレクション、関連するスクリプト/jarファイルがMEAに含まれています。1つのMEAファイルに含めることができるのは、1つのメトリック拡張のみです。メトリック拡張を元のEnterprise Managerインストール環境に追加するには、MEAからメトリック拡張をインポートする必要があります。
MEAファイルからメトリック拡張をインポートするには:
既存のメトリック拡張は、自己完結型のzipファイルとしてパッケージし、(エクスポートして)別の環境やバックアップ/ストレージに移動することができます。
既存のメトリック拡張をエクスポートするには:
メトリック拡張の削除は簡単に開始できます。ただし、実際に削除すると、Enterprise Managerによる処理が連鎖的に発生して、メトリック拡張がシステムから完全にパージされます。これには、オープンしているメトリック・アラートのクローズや、収集されたメトリック・データのパージが含まれます(最新のメトリック拡張バージョンが削除される場合)。
メトリック拡張バージョンを削除するには、すべてのターゲットからアンデプロイし、すべてのモニタリング・テンプレート(ステータスが適用保留中のテンプレートを含む)から削除しておく必要があります。
メトリック拡張を削除するには:
メトリック拡張によってデータ収集を開始するには、メトリック拡張をターゲットにデプロイする必要があります。
1つ以上のターゲットにメトリック拡張をデプロイするには:
管理者がEnterprise Managerで実行する最も一般的なタスクの1つに、メトリック・アラート条件が発生したときに電子メール通知を送信することがあります。特に、Enterprise Managerはインシデントとして定義されたアラート条件をモニターします。特定のインシデントについて、インシデントが発生したときにどのような処理を行うかをEnterprise Managerに指示するインシデント・ルール・セットを作成します。この場合、メトリック拡張によって定義されたアラート条件で構成されるインシデントが発生すると、管理者に電子メールを送信するインシデント・ルールを作成する必要があります。メトリック・アラートについて電子メールを送信する手順については、「メトリック・アラートの電子メール送信」を参照してください。
インシデント管理の詳細は、「インシデント管理の使用」を参照してください。
最新のメトリック拡張バージョンが公開されると、そのメトリック拡張の古いデプロイ済インスタンスもすべて更新する必要が生じます。
ターゲットにデプロイされている古いバージョンの拡張メトリックを更新するには:
Enterprise Managerリリース12.1.0.4では、リポジトリ側メトリック拡張を作成できます。このタイプのメトリック拡張によって、SQLスクリプトを使用してEnterprise Managerリポジトリから情報を直接抽出し、リポジトリ側の拡張を実行するターゲットに対しアラートを発生させることができます。たとえば、リポジトリ側メトリック拡張を使用すると、ホスト・ターゲットに対しるアラートの数が5を超えたときにアラートを発生させることができます。また、そのホストでのCPU使用率が95%を超え、そのホストで実行しているプロセスの数が500を超えたときにアラートを発生させることもできます。リポジトリ側メトリック拡張によって、Enterprise Managerインフラストラクチャをより柔軟にモニターすることが可能になります。
リポジトリ側メトリックを作成するには:
Oracle Integration Adaptersには、包括的で使いやすい各種ターゲット・タイプとのモニタリング接続性を備えています。このアダプタは、エンタープライズ・アプリケーションとの通信を可能にし、アプリケーション・データを標準に準拠したXMLに翻訳(またはこの逆)できます。
メトリック拡張のターゲット・タイプに応じて、UIで使用できるアダプタが決まります。たとえば、自動ストレージ管理ターゲット・タイプ用のメトリック拡張を作成する場合、3つのアダプタ(「OSコマンド - 単一列」、「OSコマンド - 複数列」および「SQL」)のみをUIから使用できます。
ターゲット・タイプの即時利用可能なメトリック定義は、ネイティブ・サポート対象のアダプタを定義し、そのようなアダプタのみがUIに表示されます。他のアダプタはそのターゲット・タイプでサポートされません。
すべてのアダプタのリストを次に示します。
指定されたOSコマンドを実行し、コマンド出力を単一値として返します。メトリックの結果は、1つの行と1つの列で構成される表です。
基本プロパティ
完全なコマンドラインはコマンド + スクリプト + 引数として構成されます。
コマンド - 実行するコマンド。たとえば、%perlBin%/perl
などです。完全なコマンドラインはコマンド + スクリプト + 引数として構成されます。
スクリプト - コマンドに渡すスクリプト。たとえば、%scriptsDir%/myscript.pl
などです。カスタム・ファイルをエージェントにアップロードでき、%scriptsDir%
ディレクトリでアクセスできます。
引数 - コマンドに付加する追加の引数。
拡張プロパティ
入力プロパティ - 追加プロパティは、標準入力ストリームを介してコマンドに渡すことができます。これは通常は、他のユーザーに見られないようにするセキュア・コンテンツ(ユーザー名やパスワードなど)で使用されます。たとえば、次の入力プロパティを追加できます。
Name=targetName
, Value=%NAME%
これは、コマンドが標準入力ストリームを介して"STDINtargetName=<target name>"として読み取ることができます。
環境変数 - 拡張プロパティは、コマンドで環境変数を介して使用できます。たとえば、Name=targetType
, Value="%TYPE%"
のような環境変数を追加できます。コマンドは、環境変数ENVtargetTypeを使用してターゲット・タイプにアクセスできます。
資格証明
ホスト資格証明 - OSコマンドの起動に使用される資格証明。
資格証明の入力 - OSコマンドの標準入力ストリームに渡される追加の資格証明。
例1
ログ・ファイルの内容を読み取り、ターゲットへの参照を含むすべての行をダンプ出力します。
アプローチ1 - grepコマンドを使用し、%NAME%パラメータを使用してターゲット名を指定します。
Command = /bin/grep %NAME% mytrace.log
アプローチ2 - perlスクリプトを実行します。
Command = %perlBin%/perl
Script = %scriptsDir%/filterLog.pl
入力プロパティ:
targetName = %NAME%
targetType = %TYPE%
filterLog.pl:
require "emd_common.pl"; my %stdinVars = get_stdinvars(); my $targetName = $stdinVars{"targetName"}; my $targetType = $stdinVars{"targetType"}; open (MYTRACE, mytrace.log); foreach $line (<MYTRACE >) { # Do line-by-line processing } close (MYTRACE);
例2
Perlスクリプトからデータベース・インスタンスに接続し、HR.JOBSサンプル・スキーマ表を問い合せます。
アプローチ1 - 入力プロパティを使用してターゲット・タイプ・プロパティから資格証明を渡します。
Command = %perlBin%/perl
Script = %scriptsDir%/connectDB.pl
入力プロパティ:
EM_DB_USERNAME = %Username%
EM_DB_PASSWORD = %Password%
EM_DB_MACHINE = %MachineName%
EM_DB_PORT = %Port%
EM_DB_SID = %SID%
connectDB.pl
use DBI; require "emd_common.pl"; my %stdinVars = get_stdinvars(); my $dbUsername = $stdinVars{"EM_DB_USERNAME"}; my $dbPassword = $stdinVars{"EM_DB_PASSWORD"}; my $dbMachine = $stdinVars{"EM_DB_MACHINE"}; my $dbPort = $stdinVars{"EM_DB_PORT"}; my $dbSID = $stdinVars{"EM_DB_SID"}; my $dbAddress = "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=$dbMachine)(Port=$dbPort))(CONNECT_DATA=(SID=$dbSID)))"; # Establish Target DB Connection my $db = DBI->connect('dbi:Oracle:', "$dbUsername@".$dbAddress, "$dbPassword", {PrintError => 0, RaiseError => 0, AutoCommit => 0}) or die (filterOraError("em_error=Could not connect to $dbUsername/$dbAddress: $DBI::errstr\n", $DBI::err)); my $query = "SELECT JOB_TITLE, MIN_SALARY FROM HR.JOBS"; my $st = $db->prepare($query); $st->execute(); while ( my ($job_title, $min_sal) = $st->fetchrow_array() ) { print "$job_title|$min_sal\n"; } $db->disconnect or warn "disconnect $DBI::errstr\n"; exit 0;
アプローチ2 - 入力資格証明を使用してモニタリング資格証明セットを渡します。
Command = %perlBin%/perl
Script = %scriptsDir%/connectDB.pl
入力資格証明:
dbCreds = MyCustomDBCreds
connectDB.pl
use DBI; require "emd_common.pl"; my %stdinVars = get_stdinvars(); my $credType = getCredType("dbCred", \%stdinVars); my %credProps = getCredProps("dbCreds", \%stdinVars); my $dbUsername = $credProps{"DBUserName"}; my $dbPassword = $credProps{"DBPassword"};
例3
ホスト・ターゲットのカスタム・モニタリング資格証明セットを作成して使用し、モニタリング資格証明をオーバーライドします。
ホスト・ターゲット・タイプのホスト資格証明の作成:
> emcli create_credential_set -set_name=myCustomCreds -target_type=host -auth_target_type=host -supported_cred_types=HostCreds -monitoring -description='My Custom Credentials'
メトリック拡張ウィザードの「資格証明」ページに移動し、ホスト資格証明の「資格証明セットの指定」を選択すると、ドロップ・ダウン・リストのオプションとしてカスタム資格証明が表示されます。
このステップでは、ホスト・ターゲット・タイプのモニタリング資格証明セットが作成されるのみです。このメトリック拡張のデプロイ先の各ターゲットで資格証明を設定する必要があります。Enterprise Managerで、「設定」、「セキュリティ」、「モニタリング資格証明」の順に選択して、資格証明を設定できます。または、コマンドラインから設定することもできます。
> emcli set_monitoring_credential -target_name=target1 -target_type=host -set_name=myCustomCreds -cred_type=HostCreds -auth_target_type=host -attributes='HostUserName:myusername;HostPassword:mypassword'
指定されたOSコマンドを実行し、各コマンド出力行を別の値として返します。メトリックの結果は、複数の行と1つの列で構成される表です。
たとえば、コマンド出力が次のようだとします。
em_result=out_x em_result=out_y
この場合、3つの列にそれぞれ値1、2、3が移入されます。
基本プロパティ
コマンド - 実行するコマンド。たとえば、%perlBin%/perlなどです。
スクリプト - コマンドに渡すスクリプト。たとえば、%scriptsDir%/myscript.pl
などです。カスタム・ファイルをエージェントにアップロードでき、%scriptsDir%
ディレクトリでアクセスできます。
引数 - コマンドに付加する追加の引数。
Starts With - メトリックの結果行の開始文字列。
例: コマンド出力が次のような場合:
em_result=4354 update test
設定Starts With = em_resultは、em_resultで開始する行のみ解析されることを指定します。
拡張プロパティ
入力プロパティ - 追加プロパティは、標準入力ストリームを介してコマンドに渡すことができます。たとえば、Name=targetName, Value=%NAME%のような入力プロパティを追加できます。コマンドは、標準入力ストリームを介してこれをSTDINtargetName=<target name>と読み取ることができます。「OSコマンド・アダプタ - 単一列」の使用例を参照してください。
環境変数 - 拡張プロパティは、コマンドで環境変数を介して使用できます。たとえば、Name=targetType, Value="%TYPE%"のような環境変数を追加できます。コマンドは、環境変数ENVtargetTypeを使用してターゲット・タイプにアクセスできます。「OSコマンド・アダプタ - 単一列」の使用例を参照してください。
資格証明
ホスト資格証明 - OSコマンドの起動に使用される資格証明。「OSコマンド・アダプタ - 単一列」の使用例を参照してください。
資格証明の入力 - OSコマンドの標準入力ストリームに渡される追加の資格証明。「OSコマンド・アダプタ - 単一列」の使用例を参照してください。
指定されたOSコマンドを実行し、各コマンド出力行(ユーザー指定の文字列で区切られた)を複数値に解析します。メトリックの結果は、複数の行と複数の列で構成される表です。
例: コマンド出力が次のような場合
em_result=1|2|3 em_result=4|5|6
デリミタが「|」に設定されていると、次のようにそれぞれが3つの列を含む2つの行になります。
基本プロパティ
完全なコマンドラインはコマンド + スクリプト + 引数として構成されます。
コマンド - 実行するコマンド。たとえば、%perlBin%/perlなどです。
スクリプト - コマンドに渡すスクリプト。たとえば、%scriptsDir%/myscript.plなどです。カスタム・ファイルをエージェントにアップロードでき、%scriptsDir%ディレクトリでアクセスできます。
引数 - 追加の引数。
デリミタ - コマンド出力を区切るために使用する文字列。
Starts With - メトリックの結果行の開始文字列。
例: コマンド出力が次のような場合
em_result=4354 out_x out_y
設定Starts With = em_resultは、em_resultで開始する行のみ解析されることを指定します。
入力プロパティ - 追加プロパティは、標準入力ストリームを介してコマンドに渡すことができます。たとえば、Name=targetName, Value=%NAME%のような入力プロパティを追加できます。コマンドは、標準入力ストリームを介してこれをSTDINtargetName=<target name>と読み取ることができます。複数の入力プロパティを指定するには、各プロパティを1行ずつ入力します。
環境変数 - 拡張プロパティは、コマンドで環境変数を介して使用できます。たとえば、Name=targetType, Value="%TYPE%のような環境変数を追加できます。コマンドは、環境変数ENVtargetTypeを使用してターゲット・タイプにアクセスできます。
拡張プロパティ
入力プロパティ - 追加プロパティは、標準入力ストリームを介してコマンドに渡すことができます。たとえば、Name=targetName, Value=%NAME%のような入力プロパティを追加できます。コマンドは、標準入力ストリームを介してこれをSTDINtargetName=<target name>と読み取ることができます。「OSコマンド・アダプタ - 単一列」の使用例を参照してください。
環境変数 - 拡張プロパティは、コマンドで環境変数を介して使用できます。たとえば、Name=targetType, Value="%TYPE%のような環境変数を追加できます。コマンドは、環境変数ENVtargetTypeを使用してターゲット・タイプにアクセスできます。「OSコマンド・アダプタ - 単一列」の使用例を参照してください。
資格証明
ホスト資格証明 - OSコマンドの起動に使用される資格証明。「OSコマンド・アダプタ - 単一列」の使用例を参照してください。
資格証明の入力 - OSコマンドの標準入力ストリームに渡される追加の資格証明。「OSコマンド・アダプタ - 単一列」の使用例を参照してください。
サポートされているカスタムSQL問合せまたは関数コールを単一インスタンス・データベースおよびReal Application Clusters(RAC)上のインスタンスに対して実行します。
プロパティ
SQL問合せ - 実行するSQL問合せ。通常のSQL文はセミコロンで終了しないでください。たとえば、SQL問合せ = "select a.ename, (select count(*) from emp p where p.mgr=a.empno) directs from emp a"のようにします。PL/SQL文もサポートされており、使用する場合は「アウト・パラメータの位置」および「アウト・パラメータ・タイプ」プロパティを移入する必要があります。
SQL問合せファイル - SQL問合せファイル。「SQL問合せ」またはSQL問合せファイルの一方のみ使用する必要があります。たとえば、%scriptsDir%/myquery.sqlなどです。カスタム・ファイルをエージェントにアップロードでき、%scriptsDir%ディレクトリでアクセスできます。
結果の置換 - SQL問合せ結果を置換します。
バインド変数 - 通常のSQL文で使用されるバインド変数をここで宣言します。たとえば、SQL問合せ = "select a.ename from emp a where a.mgr = :1"の場合は、バインド変数をName=1, Value=Bobとして宣言できます。
アウト・パラメータの位置: PL/SQL出力で使用されるバインド変数。整数値のみを指定できます。
例: SQL問合せが次のような場合
DECLARE l_output1 NUMBER; l_output2 NUMBER; BEGIN ..... OPEN :1 FOR SELECT l_output1, l_output2 FROM dual; END;
アウト・パラメータの位置 = 1、アウト・パラメータ・タイプ = SQL_CURSORを設定できます。
アウト・パラメータ・タイプ - PL/SQL出力パラメータのSQLタイプ。「アウト・パラメータの位置」のコメントを参照してください。
資格証明
データベース資格証明 - データベースの接続に使用される資格証明。
例
データベース・ターゲットのカスタム・モニタリング資格証明セットを作成して使用し、モニタリング資格証明をオーバーライドします。
データベース・ターゲット・タイプのホスト資格証明の作成:
> emcli create_credential_set -set_name=myCustomDBCreds -target_type=oracle_database -auth_target_type=oracle_database -supported_cred_types=DBCreds -monitoring -description='My Custom DB Credentials'
メトリック拡張ウィザードの「資格証明」ページに移動し、データベース資格証明の「資格証明セットの指定」を選択すると、ドロップ・ダウン・リストのオプションとしてカスタムDB資格証明が表示されます。
このステップでは、ホスト・ターゲット・タイプのモニタリング資格証明セットが作成されるのみです。このメトリック拡張のデプロイ先の各ターゲットで資格証明を設定する必要があります。Enterprise Managerで、「設定」、「セキュリティ」、「モニタリング資格証明」の順に選択して、資格証明を設定できます。また、Enterprise Managerコマンドライン・インタフェースを使用して実行することもできます。
> emcli set_monitoring_credential -target_name=db1 -target_type=oracle_database -set_name=myCustomDBCreds -cred_type=DBCreds -auth_target_type=oracle_database -attributes='DBUserName:myusername;DBPassword:mypassword'
Enterprise Manager管理エージェントは、メトリック・データとして使用されるManagement Information Base(MIB)変数情報をSNMPエージェントに問い合せることができます。
基本プロパティ
オブジェクト識別子(OID): オブジェクト識別子は、MIB階層内の管理対象オブジェクトを一意に識別します。1つ以上のOIDを指定できます。SNMPアダプタは、指定されたOIDのデータを収集します。たとえば、1.3.6.1.4.1.111.4.1.7.1.1と入力します。
拡張プロパティ
デリミタ - OIDの属性に対して複数のOIDを指定する場合に使用するデリミタ値。デフォルト値はスペース、\nまたは\tです。
表データ - メトリックに対して予期される結果に複数の行があるかどうかを指定します。使用できる値は、TRUEまたはFALSEです。デフォルト値はFALSEです。
V2タイプを含む - 指定したOIDのいずれかがSNMPV2データ・タイプかどうかを示します。使用できる値は、TRUEまたはFALSEです。デフォルト値は、FALSEです。たとえば、指定するOID値がcounter64型の場合、この属性をTRUEに設定します。
JMX対応のサーバーからJMX属性を取得し、これらの属性をメトリック表として返します。
プロパティ
Metric -- 属性を問い合せるMBean ObjectNameまたはObjectNameパターン。これはメトリック・メタデータとして指定されるため、インスタンス不可知である必要があります。MBean ObjectNameのインスタンス固有のキー・プロパティ(servernameなど)はワイルドカードで置換することが必要な場合があります。
ColumnOrder -- メトリック内に存在する必要のある順序で並べられたJMX属性のセミコロン区切りリストです。
拡張プロパティ
iIdentityCol -- JMX属性として使用可能でない場合に列として公開する必要のあるMBeanキー・プロパティ。次に例を示します。
com.myCompany:Name=myName,Dept=deptName, prop1=prop1Val, prop2=prop2Val
この例では、identityColをName;Deptとして設定すると、columnOrderプロパティで指定したJMX属性を表す列の横にNameとDeptを表す2つの追加のキー列が生成されます。
AutoRowPrefix -- 自動生成された行に使用する接頭辞。メトリック・プロパティで指定されたMBean ObjectNameパターンが複数のMBeanに一致し、columnOrderで指定されたJMX属性のいずれもそれぞれ一意でない場合は、行が自動的に生成されます。ここで指定したautoRowIdは、作成される追加のキー列の接頭辞として使用されます。たとえば、メトリックが次のように定義されているとします。
com.myCompany:Type=CustomerOrder,* columnOrder
これは、次と同じです。
CustomerName;OrderNumber;DateShipped
また、注文が2つに分けて出荷される場合にCustomerName;OrderNumber;Amountが一意でない可能性があると想定した場合、autoRowIdを"ShipItem-"と設定すると、各行のメトリックの追加のキー列にShipItem-0、ShipItem-1、ShipItem-2...ShipItem-nが移入されます。
メトリック・サービス -- 「True」または「False」。MetricServiceがターゲットのWeblogicドメインで有効になっているかどうかを示します。Oracle DMS MBeanを介して公開されるメトリックを収集する必要がある場合を除き、このプロパティは、メトリック拡張に対してほとんどの場合にfalse(選択解除)になります。MetricServiceがtrueに設定されている場合、基本プロパティmetricはMetricService表の名前になり、基本プロパティcolumnOrderはMetricService表の列名のセミコロン区切りリストになります。
注意:
JMXベースのメトリック拡張の作成に関する詳しい例は、「WebサービスおよびJMXを使用したモニタリング」の章を参照してください。
Enterprise Manager 12c以上のエージェントによってモニタリングされるターゲットでは、以前のユーザー定義メトリックおよびメトリック拡張がサポートされます。リリース12cよりも後では、メトリック拡張しかサポートされません。既存のユーザー定義メトリックがある場合、できるだけ早くメトリック拡張に移行して、管理環境内でモニタリングの中断が起こらないようにすることをお薦めします。
ユーザー定義のメトリック定義のメトリック拡張への移行は自動的には行われないので、管理者が開始する必要があります。移行プロセスでは、ユーザー定義メトリック・メタデータをメトリック拡張メタデータに移行します。
注意:
収集したユーザー定義メトリック履歴データの移行はサポートされません。
ユーザー定義メトリックをメトリック拡張に移行して、メトリック拡張をターゲットに正常にデプロイしたら、ユーザー定義メトリックを無効にするか削除する必要があります。ユーザー定義メトリックの収集を無効にすると、メタデータ(ユーザー定義メトリックの定義)は残りますが、オープンしているすべてのアラートがクリアされ、メトリック・エラーが削除され、ユーザー定義メトリックはそれ以上収集されません。ユーザー定義メトリックを削除すると、メタデータと履歴データが削除され、オープン・アラートがクリアされ、メトリック・エラーが削除されます。
ユーザー定義メトリック(UDM)からメトリック拡張(ME)への移行によって、既存のUDMが新規または既存のMEによって置き換えられます。移行プロセスの概念は、様々なターゲットに対して作成された同じ定義のUDMを1つのMEに統合することです。また、MEは複数のメトリック列をサポートするため、複数の関連するUDMを組み合せて1つのMEにすることが可能です。
この移行プロセスは次のステップで構成されています。
移行する必要があるUDMを識別します。
提供されているEM CLIコマンドを使用して、互換性のあるメトリック拡張を作成または選択します。
メトリック拡張をテストして公開します。
メトリック拡張を、元のUDMが含まれていたすべてのターゲットとテンプレートにデプロイします。既存の通知ルールもMEを参照するように更新します。
元のUDMを削除します。古いUDMの履歴データとアラートにはUIから引き続きアクセスできますが、新しいMEはそれらを継承しないことに注意してください。
UDMが使用していた資格証明は、新たに作成されるMEには移行されないことに注意してください。ユーザー・インタフェースで、メトリック拡張で必要な資格証明セットを指定できます。MEがデフォルトのモニタリング資格証明を使用しない場合は、関連するEM CLIコマンドを使用して、必要な資格証明を用意するために新しい資格証明セットを作成する必要があります。このセットは、メトリック拡張ウィザードの「資格証明」ページで使用できるようになります。
移行プロセスは、いくつかの移行セッションに分類されます。各セッションが1つ以上のUDMの移行を実行します。個々のセッションを移行するプロセスはタスクと呼ばれます。つまり、1つのセッションは1つ以上のタスクで構成されます。言い換えると、移行では1つのセッションを作成し、そのセッションの各タスクを完了するために必要な入力を提供します。ワークフローを通して、セッションとタスクのステータスを確認できます。
このプロセスの様々な手順を完了するために多くのEM CLIコマンドが使用されます。コマンド定義の詳細を確認するには、EM CLI help <コマンド>オプションを使用してください。
list_unconverted_udms - まだ移行前でセッションにも含まれないUDMのリストを表示します。
create_udmmig_session - 1つまたは複数のUDMを移行するセッションを作成します。
udmmig_summary - 進行中の移行セッションをリスト表示します。
udmmig_session_details - 特定のセッションの詳細を表示します。
udmmig_submit_metricpics - 新しいMEの作成または既存MEの使用のために、UDMとMEのマッピングを提供します。
udmmig_retry_deploys - UDMが存在しているターゲットにMEをデプロイします。このコマンドが正常に実行するためには、MEをデプロイ可能な下書きにしておくか公開しておく必要があります。
udmmig_request_udmdelete - UDMを削除し、移行プロセスを終了します。
使用例
次の問題を使用して、移行を説明するための単純なユースケースを示します。
1つのホスト(host1)を含むシステムがあり、ホストに対して1つのホストUDM(hostudm1)があるとします。目的は、このUDMに相当する新しいME(me1)を作成することです。コマンドのシーケンスは次のとおりです。
$ emcli list_unconverted_udms -------------+----------------------+-----------+-------------------- Type | Name | Metric | UDM -------------+----------------------+-----------+-------------------- host | host1 |UDM | hostudm1
このコマンドは、この段階で、移行されていないUDMまたは移行プロセス中のUDMが1つのみあることを示します。次は、セッションの作成に進みます。
$ emcli create_udmmig_session -name=migration1 -desc="Convert UDMs for host target" -udm_choice=hostudm1 -target=host:host1 Migration session created - session id is 1
このコマンドによって、名前が「migration1」、説明が「convert UDMs for host target」の移行セッションが作成されます。udm_choiceフラグには、選択されているUDMを指定します。targetフラグには、ターゲット・タイプと、UDMが存在するターゲットを指定します。移行セッションはセッションIDで識別されます。現在のセッションのIDは1です。
$ emcli udmmig_summary ------+--------------+------------------+------+------+--------+------+-------- ID | Name | Description |#Tgts |Todo |#Tmpls |Todo |IncRules ------+--------------+------------------+------+------+--------+------+-------- 1 |migration1 |Convert UDMS | | 1/1 | 0 | -/0 | -/0 ------+--------------+------------------+------+------+--------+------+--------
このコマンドでは、現在進行中のすべての移行セッションのサマリーが表示されます。「Name」フィールドと「Description」フィールドでセッションが特定されます。その他の列には、メトリック拡張に変換されているUDMへの参照を含むターゲット、テンプレートおよびインシデント・ルールの数が示されます。「Todo」列には、まだアップグレードされていないUDMへの参照を含むターゲット、テンプレートおよびインシデント・ルールの数が示されます。移行セッションは時間をかけて進めることがあるため、このコマンドを使用して、セッションで完了した部分の概要を確認します。
$ emcli list_unconverted_udms There are no unconverted udms
このUDMは移行セッションに含まれているため、未変換のUDMのリストにはもう表示されません。
$ emcli udmmig_session_details -session_id=1 Name: migration1 Desc: Convert UDMs for host target Created: <date> <time> UDM Pick: [hostudm1] UDMs being converted: ----------+----------+---------+------+------------+---------+---------+----- Type |Name |UDM |#MC |Metric |Column |DepS |DelS ----------+----------+---------+------+------------+---------+---------+----- host |host1 |hostudm1 | 0 | | |WAIT |WAIT ----------+----------+---------+------+------------+---------+---------+-----
このコマンドでは、1つの移行セッションのステータスが示されます。UDMの名前、UDMが存在するターゲットのタイプと名前がリストされます。さらに、UDMと一致するEMインスタンスに現在含まれるメトリック拡張も示されます。ユーザーは、既存の選択肢から1つを使用するか、まったく新しいメトリック拡張を作成するかを選択できます。
UDMのプロパティを照合して、互換性のあるメトリック拡張が検索されます。たとえば、ホストUDMの場合は、コマンド、スクリプトおよび引数のフィールドが同じメトリック拡張が検索されます。データベースUDMの場合は、一致するSQL問合せが検索されます。
また、「DepS」列は、UDMと一致したメトリック拡張が、そのUDMが定義されているターゲットにデプロイされたかどうかを示します。「DelS」列は、メトリック拡張がデプロイされた後でUDMが削除されたかどうかを示します。ユーザーが移行を進めるにつれて、この表は左から右に更新されます。削除ステータスの列が「complete」に設定されると、移行セッションは終了です。
$ emcli udmmig_submit_metricpicks -session_id=1 -input_file=metric_picks:filename Successfully submitted metric picks for migration session
このコマンドは、UDMを置き換えるために、既存のメトリック拡張の使用または新規のメトリック拡張の作成をEnterprise Managerインスタンスに指示します。様々なオプションがファイル(コマンドに含まれるfilename)で提供されます。このファイルの内容を次に示します。
"host,host1,hostudm1,N,ME$me1,Usage"
ファイルの各行がUDMとMEのマッピングを表します。この行には、ターゲット・タイプ、ターゲット名、UDM名、メトリック拡張が新規(N)か既存(E)かを示すフラグ、メトリック拡張名(接頭辞ME$を付ける必要があります)、および列名が含まれます。
サポートされるUDMのタイプは次のとおりです。
ホスト(host)
データベース(oracle_database)
RAC (rac_database)
ユーザーは、ファイルの収集項目の部分にデータ列の名前のみを指定できます。移行によって作成されるメトリック拡張には、UDMの構造を表す2つの列が必ず含まれます。1列のUDMの場合、1つ目の列は索引列で、もう1つの列はこのファイルに示された列名を使用します。2列のUDMの場合、MEの最初の列はキー列になり、2つ目の列では収集名が使用されます。
この段階でメトリック拡張は作成されており、メトリック拡張ライブラリに表示されます。
$ emcli udmmig_session_details -session_id=1 Name: migration1 Desc: Convert UDMs for host target Created: <date> <time> UDM Pick: [hostudm1] Udms being converted: ----------+--------+---------+------+----------+------------+---------+----- Type |Name |UDM |#MC |Metric |Column |DepS |DelS ----------+--------+---------+------+----------+------------+---------+----- host |host1 |hostudm1 | 1 | ME$me1 | Usage |WAIT |WAIT ----------+--------+---------+------+----------+------------+---------+----- #MC : There are 1 matches for udms in this session. Use emcli udmmig_list_matches to list available matches
セッション詳細のコマンドによって、このUDMに相当するメトリック拡張が1つあること(MC列の値が1)と、メトリック拡張の名前がME$me1であることが示されます。この段階では、ライブラリのページでメトリック拡張をテストできます。テストが完了して、作成されたメトリック拡張に問題がなければ、デプロイすることができます。デプロイするためには、少なくとも、メトリック拡張をデプロイ可能な下書きとして保存する必要があります。
$ emcli udmmig_retry_deploys -session_id=1 -input_file=metric_tasks:filename2 Metric Deployments successfully submitted
メトリック拡張が公開されると、システムによってジョブがトリガーされ、UDMが存在していたすべてのターゲットにメトリック拡張が自動的にデプロイされます。この処理を手動で制御する必要がある場合には、前述のコマンドを使用すると必要なステップが実行されます。このコマンドは、ターゲット・マッピングに対するUDMを含むファイルが提供される点で、submit_metricpicksオプションに似ています。これは上のfilename2で参照されます。ファイルの内容は次のとおりです。
"host,host1,hostudm1"
ファイルの各行は、UDMと、UDMが存在するターゲット・タイプとターゲットのマッピングを示します。このコマンドが実行されると、メトリック拡張を様々なターゲットにデプロイするジョブが起動されます。ジョブはユーザー・インタフェースで追跡できます。
$ emcli udmmig_request_udmdelete -session_id=1 -input_file=metric_tasks:demo_tasks Udm deletes successfully submitted
最後のコマンドでは、メトリック拡張に移行したUDMが削除されます。このコマンドは、コマンドの実行時に完了していたデプロイメントの数に応じて、部分的に終了することがあります。
$ emcli udmmig_session_details -session_id=1 Name: migration1 Desc: Convert UDMs for host target Created: <date > <time> Completed: <date > <time> UDM Pick: [hostudm1] Udms being converted: --------+----------+---------+------+------------+------------+---------+----- Type |Name |UDM |#MC |Metric |Column |DepS |DelS --------+----------+---------+------+------ ----+------------+---------+----- host |host1 |hostudm1 | 1 | ME$me1 | Usage |COMP |COMP --------+----------+---------+------+------------+------------+---------+----- #MC : There are 1 matches for udms in this session. Use emcli udmmig_list_matches to list available matches
セッション詳細のコマンドによって、移行プロセスが実際に完了したことが示されます。
メトリック拡張は、UIの外部からEnterprise Managerコマンドライン・インタフェース(EM CLI)を使用して操作できます。動詞には次の2つのカテゴリがあります。
メトリック拡張のための動詞
export_metric_extension: メトリック拡張をアーカイブ・ファイルにエクスポートします。
get_unused_metric_extensions: 使用されていないメトリック拡張のリストを取得します。
import_metric_extension: メトリック拡張アーカイブ・ファイルをインポートします。
publish_metric_extension: すべての管理者が使用できるようにメトリック拡張を公開します。
save_metric_extension_draft: メトリック拡張のデプロイ可能な下書きを保存します。
ユーザー定義メトリックを移行するための動詞
abort_udmmig_session: ユーザー定義メトリック移行セッションを(一部)中断します。
analyze_unconverted_udms: 変換されていないユーザー定義メトリックを分析します。
create_udmmig_session: ユーザー定義メトリック移行セッションを作成します。
list_unconverted_udms: 移行セッションにまだ含まれていないユーザー定義メトリックをリスト表示します。
udmmig_list_matches: 特定のユーザー定義メトリック移行セッション内で、ユーザー定義メトリックごとに一致するメトリックをリスト表示します。
udmmig_request_udmdelete: ターゲットからのユーザー定義メトリックの削除を要求します。
udmmig_retry_deploys: ターゲットへのメトリック拡張のデプロイを再試行します。
udmmig_session_details: 特定のユーザー定義メトリック移行セッションの詳細を取得します。
udmmig_submit_metricpicks: セッションのユーザー定義メトリックを置換するメトリックを選択します。
udmmig_summary: すべてのユーザー定義メトリック移行セッションのステータスのサマリーを表示します。
udmmig_update_incrules: 置換のメトリック参照を含むようにユーザー定義メトリックのインシデント・ルールを更新します。
メトリック拡張のための動詞
emcli export_metric_extension -file_name=<name of the metric extension archive> -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension> Description: Export a metric extension archive file. Options: -file_name=<file name> The name of the metric extension archive file to export into. -target_type=<target type> Target type of the metric extension. -name=<name> Name of the metric extension. -version=<version> Version of the metric extension to be exported. emcli get_unused_metric_extensions Description: Get a list of metric extensions that are deployed to agents but not attached to any targets. emcli import_metric_extension -file_name=<name of the metric extension archive> -rename_as=<name of the metric extension to import as> Description: Import a metric extension archive file. Options: -file_name=<file name> The name of the metric extension archive file to be imported. -rename_as=<metric extension name> Import the metric extension using the specified name, replacing the name given in the archive. emcli publish_metric_extension -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension> Description: Publish a metric extension for use by all administrators. The metric extension must currently be a deployable draft. Options: -target_type=<target type> Target type of the metric extension. -name=<name> Name of the metric extension. -version=<version> Version of the metric extension to be published. emcli save_metric_extension_draft -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension> Description: Save a deployable draft of a metric extension. The metric extension must currently be in editable state. Once saved as draft, the metric extension will no longer be editable. Options: -target_type=<target type> Target type of the metric extension. -name=<name> Name of the metric extension. -version=<version> Version of the metric extension to be saved to draft.
ユーザー定義メトリックの動詞
emcli abort_udmmig_session -session_id=<sessionId> [-input_file=specific_tasks:<complete path to file>] Description: Abort the migration of user-defined metrics to MEs in a session Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary [-input_file=specific_tasks:<complete file path>] This optional parameter points at a file name that contains a target, user-defined metric, one per line in the following format: <targetType>,<targetName>,<collection name> Use targetType=Template to indicate a template Use * for collection name to abort all user-defined metrics for a target emcli analyze_unconverted_udms [-session_id=<sessionId>] Description: Analyze user-defined metrics and list unique user-defined metrics, any possible matches, and templates that can apply these matching metric extensions Options: -session_id=<id of a session to be reanalyzed> Not specifying a session id causes the creation of a analysis session that contains all unconverted user-defined metrics. You can specify this session id in future invocations to get fresh analysis. emcli create_udmmig_session -name=<name of the session> -desc=<description of the session> [-udm_choice=<specific udm to convert>]* {-target=<type:name of the target to migrate> }* | {-input_file=targetList:<complete path to file>}; {-template=<name of the template to update> }* | {-input_file=templateList:<complete path to file>} [-allUdms] Description: Creates a session to migrate user-defined metrics to metric extensions for targets. Options: -name=<session name> The name of the migration session to be created. -desc=<session session description> A description of the migration session to be created. -udm_choice=<udm name> If the session should migrate specific user-defined metrics, specify them Otherwise, all user-defined metrics will be migrated -target=<type:name of target to migrate> The type:name of the target to be updated. Multiple values may be specified. -input_file=targetList:<complete file path> This takes a file name that contains a list of targets, one per line in the following format: <targetType>:<targetName> -template=<name of template to migrate> The name of the template to update.Multiple values may be specified -input_file=templateList:<complete file path> This takes a file name that contains a list of templates, one name per line -allUdms This forces the session to contain all user-defined metrics from targets and templates (default behavior just picks those not in a session) emcli list_unconverted_udms [-templates_only] Description: Get the list of all user-defined metrics that are not yet in a migration session Options: -templates_only Only lists unconverted user-defined metrics in templates. emcli udmmig_list_matches -session_id=<sessionId> Description: Lists the matching metrics per user-defined metric in a migration session Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary emcli udmmig_request_udmdelete -session_id=<sessionId> -input_file=metric_tasks:<complete path to file> Description: Delete the user-defined metrics that have been replaced by Metric Extenions Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary -input_file=metric_tasks:<complete file path> This takes a file name that contains a target, user-defined metric, one per line in the following format: <targetType>,<targetName>,<collection name> emcli udmmig_retry_deploys -session_id=<sessionId> -input_file=metric_tasks:<complete path to file> Description: Retry the deployment of metric extensions to a target Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary -input_file=metric_tasks:<complete file path> This takes a file name that contains a target, user-defined metric, one per line in the following format: <targetType>,<targetName>,<collection name> emcli udmmig_submit_metricpicks -session_id=<sessionId> -input_file=metric_picks:<complete path to file> Description: Supply the metric picks to use to replace user-defined metrics per target in a session Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary -input_file=metric_picks:<complete file path> This takes a file name that contains a target, user-defined metric, metric pick, one per line in the following format: <targetType>,<targetName>,<collection name>,[N/E],<metric>,<column> using N if a new metric should be created or E if an existing metric is referenced. emcli udmmig_summary [-showAll] Description: Gets the summary details of all migration sessions in progress Options: -showAll This prints out all sessions including those that are complete. By default, only in-progress sessions are listed. emcli udmmig_update_incrules -session_id=<sessionId> -input_file=udm_inc_rules:<complete path to file> Description: Update Incident Rules that reference user-defined metrics with a reference to replacing metric extension. Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary -input_file=udm_inc_rules:<complete file path> This takes a file name that contains rule, user-defined metric, metric, one per line in the following format: <ruleset id>,<rule id>,<udm name>,<metric name>