前のトピック: ツールの使用次のトピック: レポートの識別子のリスト


構文

ツールを使用するには、以下のコマンドを実行します。

java -jar arreporttool.jar –-protocol <protocol> --host <host> 
--port <app_server_port> --admin-orgid <admin-organization> 
--admin-id <admin-user-id> --admin-password <password> 
[--report-type hour | day | month [duration] | range] 
--report-id <Report ID> --reporturl <Url of the report> 
--is-filter-req <true | false> --data-type <Data Type> 
--reportdata [Report Data] --start-date-time <date-and-time> [--end-date-time <date-andtime>] [--logfile <logfile>] 
[--log-level <loglevel>][log-file-max-size] <logfilesize>] [--organizations <target orgNames>] [--userName <User/Admin Name>] [--output-file <output-file>.CSV] [--is-url-encoded [true|false]]

以下の表に、ツールでサポートされているオプションを示します。

オプション

Description

protocol

通信に使用するプロトコル。 指定可能な値は http と https です。 デフォルトのプロトコルは http です。

ホスト

管理コンソールを展開したシステムのホスト名または IP アドレス。

app_server_port

管理コンソールがリスンするポート。

admin-orgid

管理者が属する組織。

admin-id

一意の管理者 ID。

admin-password

管理者パスワード。

report-type

時間、日、月または範囲を指定します。

  • 時間、日、月の後に数値を指定できます。 たとえば、--report-type day 2 は、指定した start-date-time からの 2 日間の記録を示します。
  • 範囲: range を指定した場合は、end-date-time を指定します。

report-id

取得するレポートの識別子。 使用できるレポート識別子のリストについては、「レポートの識別子のリスト」を参照してください。

reporturl

レポートの管理者の URL。 使用できるレポートの URL のリストについては、「レポート URL のリスト」を参照してください。

is-filter-req

デフォルトでは true に設定されます。 たとえば、AuthMinder レポートなど、フィルタ ページがないレポートに対してはこの値を false に設定します。

data-type

これは AuthMinder レポートを ACTIVE または STAGING に指定する場合にのみ使用できます。

reportdata

開始日と終了日のほかに、レポートによってはさらにフィルタが必要になることがあります。 これらの追加フィルタはレポート データとして指定します。 レポート データは「キー=値」の形式で指定する必要があります。 複数のキーと値のペアを区切るには、セミコロンを使用します。

 

レポートのデータに ; または = が含まれている場合は、URL エンコードする必要があります。 URL エンコードされた値を渡す場合には、is-url-encoded パラメータを true に設定します。

start-date-time

レポートの内容をこの後から取得する必要がある日付または時刻を指定します。

形式

MM/dd/yyyy HH:mm:ss

時間(HH)および分(mm)はオプションで、時間単位でのレポートにのみ使用します。 日単位および月単位のレポート対しては、日付部分だけを使用します。 デフォルトでは、タイムゾーンは GMT です。

例:

03/21/2010 09:10:20

end-date-time

(オプション)レポートの内容をこの前まで選択する必要がある日付または時刻を指定します。

logfile

(オプション)ログ ファイルの場所を指定します。 ログ ファイルが指定されていないと、arreporttool.log ファイルが現在のディレクトリに自動的に作成されます。

log-level

(オプション)ログのレベルを指定します。 デフォルトのログ レベルは[情報]です。

log-file-max-size

(オプション)ログ ファイルの最大サイズを指定します。 デフォルト値は 10MB です。

organizations

(オプション)レポートの対象となる組織の名前をセミコロンで区切って指定します。 組織が必須パラメータであるレポートにはこの値を指定する必要があります。 組織名にセミコロン(;)が含まれる場合は、値を URL エンコードする必要があります。

 

URL エンコードされた値を渡す場合には、is-url-encoded パラメータを true に設定します。

userName

(オプション)ユーザまたは管理者の名前を指定します。

output-file

(オプション)レポートの内容を書き込む必要がある出力ファイルを指定します。 ファイル名を指定しないと、<reporttype>-timestamp.CSV が使用されます。

is-url-encoded

(オプション)この値は、レポート データや組織に URL エンコードされた情報が含まれているかどうかによって true または false に設定します。 デフォルト値は false です。