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

目次

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

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

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

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

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

コマンドラインの使用法

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

reportercmd -report "Global Bandwidth per Service #1"-dbdriver"com.mysql.jdbc.Driver"-dburl "jdbc:mysql://127.0.0.1:3306/apricot" -dbuser "pqb_admin"-dbpassword "pqb_admin"-policysce "10.1.12.85"-params"numhours=240000000;seip=10.1.12.85;avgdata=true;link=Link 0,Link 1;traficdir=Both Directions;services=Messaging Service,Generic UDP Service,Generic TCP Service,News Service,FTP Service,Browsing Service,Default Service"-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 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;... "

プロパティ ビューからのパラメータ

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

-o " filename "

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

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

-format " fileformat "

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

jpeg

csv

 

-show

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

 

-help

 

 

-list

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

 

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

 

手順概要

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

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

3. [ OK ] をクリックします。

4. 次のうちいずれかを実行します。

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

6. 次の必須フラグを追加します。

7. パラメータを変更します。たとえば numhours パラメータを変更できます。

8. コマンドを実行します。

手順詳細


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

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

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

図6-1

 

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

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

ステップ 4 次のうちいずれかを実行します。

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

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

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

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

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

-o " filename "

-format " fileformat "

ステップ 7 パラメータを変更します。たとえば numhours パラメータを変更できます。

図6-2

 

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

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


 

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

手順概要

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

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

3. [ OK ] をクリックします。

4. 以前の手順のステップ 5 以降を実行します。

手順詳細


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

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

図6-3

 

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

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

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

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

ステップ 4 以前の手順のステップ 5 以降を実行します。