Cisco Service Control Application Reporter ユーザ ガイド
SCA Reporter の CLI
SCA Reporter の CLI
発行日;2012/01/31 | 英語版ドキュメント(2011/03/23 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 4MB) | フィードバック

目次

SCA Reporter の CLI

概要

CLI の概要

レポートのスケジューリング

構文と使用法

コマンドラインの使用法

コマンドライン スイッチ

コマンドライン オプション

レポート インスタンスでの Reporter コマンドの生成方法

レポート テンプレートでの Reporter コマンドの生成方法

SCA Reporter の CLI

概要

この章では、Cisco Service Control Application Reporter(SCA Reporter)の CLI(コマンドライン インターフェイス)を使用して SCA Reporter 機能を実行するさまざまな方法(構文、スイッチ、アプリケーションのオプションなど)について説明します。

「CLI の概要」

「レポートのスケジューリング」

「構文と使用法」

CLI の概要

SCA Reporter の CLI(コマンドライン インターフェイス)はコマンドライン アプリケーションであり、SCA Reporter GUI の機能を補足するものです。CLI は、SCA Reporter の GUI よりも高機能で柔軟であり、サードパーティ製アプリケーションに統合して使用量ベースの出力および統計ベースの出力を生成できます。

CLI は、次の機能を備えています。

Windows または Linux 環境で実行できます。

定義済みのレポート インスタンスを実行したり、レポート テンプレートを使用したりできます。

レポートを定期的に生成するようにスケジューリングできます。

レポートのスケジューリング

Reporter CLI を使用すると、選択したレポートを定期的に生成できます。これを行うには、外部のスケジューリング ユーティリティ(cron、PyCron、Windows スケジューラなど)を設定する必要があります。次の項で説明するとおり、既存のレポート インスタンス、またはレポート テンプレートを使用できます。

次に示すのは、1 時間ごとに「Global Bandwidth per Service」レポートを生成する cron 行の例です。

20 * * * * reportercmd -report "Global Bandwidth per Service #1" -params \
"numhours=24;units=Mbit/s;avgdata=true;trafficdir=Both Directions" \ -format jpeg -o GBpS1.jpeg

構文と使用法

SCA Reporter をコマンドライン バージョンとして実行し、入力をパラメータとして渡すことができます。[Templates] ビューでは、レポート インスタンスまたはレポート テンプレートのいずれかから CLI コマンドを作成できます。データベース情報および SCE プラットフォームの IP パラメータは、作成された CLI コマンドに設定済みパラメータとともに組み込まれます。

コマンドを作成すると、そのコマンドは自動的にクリップボードにコピーされるので、コマンド ファイル シェルまたはコマンド プロンプトに貼り付け、必要な変更を加えてから実行できます。データを保存するためのファイル名と形式を追加する必要があります。これらのパラメータは、コマンド作成時には含まれていません。

元のレポート インスタンスに存在するすべてのパラメータが、params スイッチに組み込まれるわけではありません。パラメータが CLI 呼び出しで具体的にリストされていないときは、次のようになります。

コマンドがレポート インスタンスに基づいている場合、その値はレポート インスタンスから取得されます。

コマンドがレポート テンプレートに基づいている場合は、デフォルト値が使用されます (デフォルト値のない必須パラメータの値は定義する必要があります)。

「コマンドラインの使用法」

「コマンドライン スイッチ」

「コマンドライン オプション」

「レポート インスタンスでの Reporter コマンドの生成方法」

「レポート テンプレートでの Reporter コマンドの生成方法」

コマンドラインの使用法

SCA Reporter アプリケーションは、次のようなコマンドを使用してレポート インスタンスに対して呼び出すことができます。

reportercmd -report "Global Bandwidth per Service #1" -dbdriver "com.mysql.jdbc.Driver" -dburl "jdbc:mysql://10.56.201.89:3306/apricot" -dbuser "pqb_admin" -dbpassword "pqb_admin" -policysce "10.56.201.87" -params "titleText=Global Bandwidth per Service;services=Flash Yahoo,HTTP,Google Talk File Transfer,Other Flash;numhours=24000;trafficdir=Both Directions;link=Link 0,Link 1;showSce=false;avgdata=true;units=Mbps" -o "myfile" -format "jpeg"

 

SCA Reporter アプリケーションは、次のようなコマンドを使用してレポート テンプレートに対して呼び出すことができます。

reportercmd -template "Global Bandwidth per Service" -dbdriver "com.sybase.jdbc3.jdbc.SybDriver" -dburl "jdbc:sybase:Tds://10.56.99.13:4100" -dbuser "pqb_admin" -dbpassword "pqb_admin" -policysce "10.56.98.10" -params "endtime=2008-04-13 10:46:20;titleText=Global Bandwidth per Service;services=Flash Yahoo,HTTP,Google Talk File Transfer,Other Flash;numhours=24000;starttime=2008-04-12 10:46:20;trafficdir=Both Directions;seip=10.56.201.87;link=Link 0,Link 1;showSce=false;avgdata=true;units=Mbps" -hierarchy services;1 -o "myfile" -format "jpeg"

 

SCA Reporter から CLI コマンドの基礎となる文字列を生成できます。生成されたコマンドには、 -o パラメータや -format パラメータは含まれていません。これらはコマンドに追加する必要があります。その他のパラメータを修正することもできます。

コマンドライン スイッチ

SCA Reporter アプリケーションを呼び出す際、コマンドラインに次のスイッチを含めることができます。

-report

-dbdriver

-dburl

-dbuser

-dbpassword

-policysce

-params

-o

-format

-show

-template

-dbdriver

-dburl

-dbuser

-dbpassword

-policysce

-params

-o

-format

-show

-help

-list

コマンドライン オプション

SCA Reporter アプリケーションを呼び出すコマンド ラインのオプションについて、 表 6-1 で説明します。

 

表 6-1 SCA Reporter アプリケーションのコマンドライン オプション

オプション
SCA Reporter による処理
説明

-report " report-name "

指定された名前のレポート インスタンスを使用して、レポートを生成します。

このパラメータは、既存のレポート インスタンスからレポートを生成するときに使用します。

-template " template-name "

指定された名前のレポート テンプレートを使用して、レポートを生成します。

このパラメータは、テンプレートからレポートを生成するときに使用します。

-dbdriver " db-driver "

データベースのドライバ

SCA Reporter で設定されているものと同じデータベース

-dburl " db-url "

データベースの URL

--

-dbuser " db-user "

データベースのユーザ

--

-dbpassword " db-password "

データベースのパスワード

--

-policysce " IP of SCE for policy data "

サービス コンフィギュレーション データがレポートで使用される SCE プラットフォームの IP アドレス

SCA Reporter で設定されている SCE プラットフォームの IP アドレス

-params " param1=value1;... "

[Properties] ビューからのパラメータ

特定のパラメータを指定しない場合は、デフォルト値が使用されます。

-o " filename "

出力を保存するファイルの名前

そのファイル名がすでに存在する場合、元のファイルは上書きされます。

-format " fileformat "

レポートをグラフとして出力するか、表として出力するかを指定します。 fileformat パラメータには、次の値のいずれかを指定できます。

jpeg

csv

pdf

--

-show

実行せずに、レポートまたはテンプレートの構造(パラメータを含む)を表示します。

--

-help

--

--

-list

すべてのテンプレート グループとレポート テンプレートの一覧を出力します。

--

- hierarchy "mode; level; group-for sorted"

レポート階層アトリビュートを定義します。

mode:階層ツリーのモード。このアトリビュートでは、次のいずれかの値を使用できます。

services:サービス重要度モード

sorted:設定済みサービス ツリー モード

level:ツリーが展開されているときのデフォルト レベル。

group-for sorted:各グループに含める項目数。

(注) このアトリビュートは、sorted が指定されている場合のみ関連します。

--

レポート インスタンスでの Reporter コマンドの生成方法


ステップ 1 [Templates] ビューからレポート インスタンスを選択します。

ステップ 2 タブのドロップダウン メニューから [Show Cmd] を選択します。

コマンドライン呼び出しダイアログボックスが表示され(図 6-1 を参照)、生成されたコマンドが表示されます。

図 6-1 コマンドライン呼び出しダイアログ

 

ステップ 3 [OK] をクリックします。

コマンドおよびすべてのスイッチとパラメータがクリップボードに配置されます。

ステップ 4 ファイルまたはコマンド プロンプトを開きます。

次のいずれかを実行します。

シェルからコマンドを実行するファイルを開き、Reporter ディレクトリにファイルを保存します。

CLI コマンドを実行するコマンド プロンプトを開き、ディレクトリを Reporter ディレクトリに変更します。

ステップ 5 クリップボードの内容を貼り付けます。

ファイルまたはコマンド ラインにコマンドが貼り付けられます。

ステップ 6 必須フラグを追加します。

-o " filename "

-format " fileformat "

ステップ 7 (オプション)パラメータを変更します。たとえば numhours パラメータを変更します(図 6-2 を参照)。

図 6-2 パラメータ変更の例

 

ステップ 8 コマンドを実行します。

エクスポートされたファイルが定義済みディレクトリに保存され、レポート インスタンス名にタイム スタンプが付きます。


 

レポート テンプレートでの Reporter コマンドの生成方法


ステップ 1 [Templates] ビューからレポート テンプレートを選択します。

ステップ 2 タブのドロップダウン メニューから [Show Cmd] を選択します(図 6-3 を参照)。

コマンドライン呼び出しダイアログボックスが表示され、生成されたコマンドが表示されます。

図 6-3 コマンドライン呼び出しダイアログ

 

デフォルト値があるパラメータには、デフォルト値が付与されます。デフォルト値のない必須パラメータは、___(下線)の値で示されます。

ステップ 3 [OK] をクリックします。

コマンドおよびすべてのスイッチとパラメータがクリップボードに配置されます。

ステップ 4 ファイルまたはコマンド プロンプトを開きます。

次のいずれかを実行します。

シェルからコマンドを実行するファイルを開き、Reporter ディレクトリにファイルを保存します。

CLI コマンドを実行するコマンド プロンプトを開き、ディレクトリを Reporter ディレクトリに変更します。

ステップ 5 クリップボードの内容を貼り付けます。

ファイルまたはコマンド ラインにコマンドが貼り付けられます。

ステップ 6 必須フラグを追加します。

-o " filename "

-format " fileformat "

ステップ 7 (オプション)パラメータを変更します。たとえば numhours パラメータを変更します(図 6-4 を参照)。

図 6-4 パラメータ変更の例

 

ステップ 8 コマンドを実行します。

エクスポートされたファイルが定義済みディレクトリに保存され、レポート インスタンス名にタイム スタンプが付きます。