API サポート

(1)

A P P E N D I X

B

API

サポート

この章では、Clean Access Manager の API サポートについて説明します。次の内容について説明します。 • 「概要」（P.B-1） • 「認証要件」（P.B-2） • 「デバイスフィルタの操作」（P.B-3） • 「証明済みデバイスリストの操作」（P.B-7） • 「ユーザの操作」（P.B-8） • 「ゲストアクセスの操作」（P.B-12） • 「OOB スイッチ管理の操作」（P.B-13） • 「レポートの操作」（P.B-14）

概要

Cisco NAC アプライアンスには、HTTPS POST を使用して特定の操作を実行できる cisco_api.jsp という名前のユーティリティスクリプトがあります。Clean Access Manager の実際の Cisco NAC アプライアンス API には、https://<cam-IP-or-hostname>/admin/cisco_api.jsp でアクセスします。

Cisco NAC アプライアンス API の Web マニュアルページにアクセスするには、CAM Web コンソールにログインし、CAM コンソールの URL の「admin/」の後に「cisco_api.jsp」と入力します。ブラウザが Cisco NAC アプライアンス API の Web マニュアルページにリダイレクトされます。

（注） cisco_api.jsp のマニュアルページにアクセスする前に、CAM Web コンソールに先にログインする必

要があります。

この API を使用する場合は、次の点に注意してください。

• スクリプト言語（Java、Perl など）を理解して使用する必要があります。また、スクリプトを実行するマシンには、スクリプトソフトウェアをインストールする必要があります。

• Cisco TAC では、スクリプトパッケージ（Java、Perl など）のデバッグはサポートしません。

（注） CAM Web コンソールインターフェイスからの MAC アドレスフィルタの追加方法について、一般的

(2)

付録 B API サポート 認証要件

認証要件

API にアクセスするには、SSL を介した認証が必要です。次の 2 つの認証方式がサポートされています。 • セッションベース認証この方式では、管理者は adminlogin 関数および adminlogout 関数を使用して、サーバとのクッキーによるセッションを作成します。adminlogin 関数は、admin ユーザのログインを行い、ログインが成功した場合は、サーバからの HTTP 応答にはセッション中に使用されるセッションのクッキーが含まれます。adminlogout 関数は、admin ユーザのログアウトを行い、セッションを無効にします。ただし、adminlogout 関数を使用しない場合は、設定済みまたはデフォルトの admin セッションタイムアウトに従って、CAM がセッションを終了します。 • 関数ベース認証セッションベース認証を使用しない場合は、関数ベース認証を使用できます。この方式では、要求

URL に admin および passwd の引数を使用して、API の呼び出しのたびに admin アカウント資格情報を渡すことで、admin の認証が行われます。関数による認証の場合、既存のスクリプトで使用しているすべての関数に admin および passwd のパラメータを追加する必要があります。この場合、adminlogin 関数および adminlogout 関数は使用しません。

管理者の操作

adminlogin 関数および adminlogout 関数を使用して、セッション ID のクッキーを使用するセッションベース認証のシェルスクリプトを作成します。セッションベース認証を使用しない場合は、その代わりに、各 API 呼び出しに admin および passwd の引数を含める必要があります。

adminlogin

adminlogin 関数は、admin のログインを行い、クッキにーよるセッションを開始します。必須入力パラメータ： • op：adminlogin • admin：管理者アカウントのユーザ名 • passwd：管理者アカウントのパスワード出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

<

後続の任意の操作

_>

adminlogin を介して取得した HTTP セッションのクッキーは、以降の任意の操作でも HTTP 要求の一部として返す必要があります。必須入力パラメータ： • op：<任意の操作> • <操作に固有のパラメータ>

(3)

付録 B API サポート デバイス フィルタの操作

adminlogout

adminlogout 関数は、管理者のログアウトを行い、セッションを無効にします。必須入力パラメータ： • op：adminlogout 出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

デバイス

フィルタの操作

次の API は、CAM のデバイスフィルタリスト（ユーザログイン要求を回避するデバイス）に対する操作を実行します。 • 「addmac」（P.B-3） • 「removemac」（P.B-4） • 「checkmac」（P.B-4） • 「getmaclist」（P.B-5） • 「removemaclist」（P.B-5） • 「addsubnet」（P.B-6） • 「updatesubnet」（P.B-6） • 「removesubnet」（P.B-7）（注）「changeuserrole」（P.B-11）も参照してください。

addmac

addmac 関数は、1 つ以上の MAC アドレスをデバイスフィルタリストに追加します。必須入力パラメータ： • op：addmac • mac：正確な MAC アドレスまたは範囲を指定します。サポートされる形式：00:01:12:23:34:45、00:01:12:*、または 00:01:12:23:34:45-11:22:33:44:55:66 （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。任意の入力パラメータ： • ip：正確な MAC アドレスの IPv4 アドレスを指定します。ワイルドカードまたは範囲を使用して、 MAC アドレス範囲を指定する場合、「ip」パラメータは使用しないでください。サポートされる形式：192.168.0.10

(4)

付録 B API サポート

デバイス フィルタの操作

• type：deny（デフォルト）、allow、userole、check、または ignore の文字列のうちいずれかを指定します。

• role：ロール名を指定します。role パラメータは、Unauthenticated ロール（デフォルト）の場合

は必須ではありませんが、「userole」または「check」の場合は必須です。

• desc：説明を入力します。

• ssip：Clean Access Server を Clean Access Manager に設定するために使用した IP アドレスを指定します。デフォルトは global です。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

removemac

removemac 関数は、1 つ以上の MAC アドレスをデバイスフィルタリストから削除します。必須入力パラメータ： • op：removemac

• mac：デバイスフィルタリストから削除する 1 つ以上の MAC アドレスを指定します。MAC アド

レスは、ワイルドカードを含む表示形式に正確に一致している必要があります。カンマで区切って

複数の MAC アドレスを指定できます。

（注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。

任意の入力パラメータ：

• ssip：Clean Access Server を Clean Access Manager に設定するために使用した IP アドレスを指定します。デフォルトは global です。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

checkmac

checkmac 関数は、デバイスフィルタリストを照会し、特定の MAC アドレスが存在するかどうかを確認します。必須入力パラメータ： • op：checkmac

• mac：MAC アドレスを指定します。MAC アドレスは、表示形式（00:01:12:23:34:45）に正確に一致している必要があります。

任意の入力パラメータ：

• ssip：Clean Access Server の IP アドレスを指定します。デフォルトでは、checkmac 関数はグローバルフィルタだけを確認します。ssip が指定されている場合は Clean Access Server フィルタも確認します。

(5)

付録 B API サポート デバイス フィルタの操作 出力パラメータ： コメント • Success：次のいずれか:   または：    デバイスフィルタ文字列内の説明： –「IP=x.x.x.x」は、設定された IP アドレスを含むフィルタの場合に示されます。 –「CAS=y.y.y.y」は、サーバ固有のフィルタの場合に示されます。 –「ROLE=zzz」は、ROLE/CHECK タイプを含むフィルタの場合に示されます。 – 指定された単一 MAC アドレスについて、checkmac 関数は、最初に一致したフィルタを返します。このフィルタは、単一 MAC アドレスのフィルタか MAC アドレスのワイルドカード/ 範囲フィルタです。 • Failure：エラー文字列

getmaclist

getmaclist 関数は、デバイスフィルタリスト全体を取得します。必須入力パラメータ： • op：getmaclist 出力パラメータ： コメント • Success：   <!--MAC=0A:13:07:9B:82:60,[IP=x.x.x.x,][CAS=y.y.y.y,]TYPE=ALLOW,[ROLE=zzz,]DESCRIPTION =My Filter--... デバイスフィルタ文字列内の説明： –「IP=x.x.x.x」は、設定された IP アドレスを含むフィルタの場合に示されます。 –「CAS=y.y.y.y」は、サーバ固有のフィルタの場合に示されます。 –「ROLE=zzz」は、ROLE/CHECK タイプを含むフィルタの場合に示されます。 • Failure：エラー文字列

removemaclist

removemaclist 関数は、デバイスフィルタリスト全体を削除します。必須入力パラメータ：

(6)

付録 B API サポート デバイス フィルタの操作 • op: removemaclist 出力パラメータ： • 操作の失敗を示す出力は、 です。 • 操作の成功を示す出力は、 です。

addsubnet

addsubnet 関数は、デバイスリストにサブネットエントリを追加します。必須入力パラメータ： • op：addsubnet

• subnet：サブネットアドレスを表すためにサポートされている a.b.c.d 形式（subnet=10.210.0.0 など）。

• mask：CIDR 形式のマスク（mask=16 など）。任意の入力パラメータ：

• type：deny、allow、userole のいずれかの文字列。デフォルトは deny です。

• role：ロール名を指定します。デフォルトは unauthenticated です。type が userole の場合は必須です。

• desc：任意の説明文です。

• ssip：デフォルトは global です。Clean Access Server を Clean Access Manager に設定するために使用した IP アドレスを指定します。出力パラメータ：  の形式のコメントが返されます。メッセージ値が 0 の場合、操作は成功です。それ以外の場合、エラー文字列が出力されます。

updatesubnet

updatesubnet 関数は、デバイスリストのサブネットエントリを更新します。必須入力パラメータ： • op：updatesubnet

• subnet：サブネットアドレスを表すためにサポートされている a.b.c.d 形式（subnet=10.210.0.0 など）。

• mask：CIDR 形式のマスク（mask=16 など）。任意の入力パラメータ：

• type：[deny, allow, userole] のいずれかの文字列。デフォルトは deny です。

• role：ロール名を指定します。デフォルトは unauthenticated です。type が userole の場合は必須です。

• desc：任意の説明文です。

• ssip：デフォルトは global です。Clean Access Server を Clean Access Manager に設定するために使用した IP アドレスを指定します。

(7)

付録 B API サポート 証明済みデバイス リストの操作  の形式のコメントが返されます。メッセージ値が 0 の場合、操作は成功です。それ以外の場合、エラー文字列が出力されます。

removesubnet

removesubnet 関数は、デバイスリストからサブネットエントリを削除します。必須入力パラメータ： • op: removesubnet

• subnet: サブネットアドレスを表すためにサポートされている a.b.c.d 形式（subnet=10.210.0.0 など）

• mask: CIDR 形式のマスク（mask=16 など）任意の入力パラメータ：

証明済みデバイス

リストの操作

次の API は、証明済みデバイスリスト（ポスチャ評価要件を満たしているデバイス）に対するアクションを実行します。 • 「addcleanmac」（P.B-7） • 「removecleanmac」（P.B-8） • 「clearcertified」（P.B-8）

addcleanmac

addcleanmac 関数は、1 つ以上の MAC アドレスを証明済みデバイスリストに免除デバイスとして追加します。必須入力パラメータ： • op：addcleanmac • mac：追加する MAC アドレスを指定します。サポートされる形式 00:01:12:23:34:45、 00-01-12-23-34-45、または 000112233445 （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。任意の入力パラメータ：

出力パラメータ： コメント

• Success：メッセージ値 0 • Failure：エラー文字列

(8)

付録 B API サポート ユーザの操作

removecleanmac

removecleanmac 関数は、1 つ以上の MAC アドレスを証明済みデバイスリストから削除します。必須入力パラメータ： • op：removecleanmac • mac：削除する 1 つ以上の MAC アドレスを指定します。サポートされる形式 00:01:12:23:34:45、 00-01-12-23-34-45、または 000112233445 （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。任意の入力パラメータ：

• Success：メッセージ値 0

• Failure：ssip が指定されていない場合で、かつ複数の Clean Access Server から MAC アドレスを削除できない場合は、1 つ以上のエラー文字列が表示されることがあります。

clearcertified

clearcertified 関数は、Clean Access 証明済みデバイスリストから既存のエントリをすべて削除します。

必須入力パラメータ： • op：clearcertified （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

ユーザの操作

次の API は、ユーザ管理の操作を実行します。 • 「kickuser」（P.B-9） • 「kickuserbymac」（P.B-9） • 「kickoobuser」（P.B-10） • 「queryuserstime」（P.B-10） • 「renewuserstime」（P.B-10）

(9)

ユーザの操作

• 「changeuserrole」（P.B-11）

• 「changeloggedinuserrole」（P.B-11）

（注）「getlocaluserlist」（P.B-12）、「addlocaluser」（P.B-12）、および「deletelocaluser」（P.B-13）も参照してください。

kickuser

kickuser 関数は、1 つ以上の現在ログインしている In-Band ユーザのアクティブセッションを終了し、

In-Band Online Users リストからユーザを削除します。必須入力パラメータ： • op：kickuser • ip：1 つの IP アドレスまたはカンマ区切りの IP アドレスのリストを指定します。（注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

kickuserbymac

kickuserbymac 関数は、1 つ以上のログインしている In-Band ユーザの MAC アドレスによってアク

ティブセッションを終了し、In-Band Online Users リストからユーザを削除します。必須入力パラメータ：

• op：kickuserbymac

• mac：1 つの MAC アドレスまたはカンマ区切りの MAC アドレスのリストを指定します。

• Success：メッセージ値 0 • Failure：エラー文字列

(10)

ユーザの操作

kickoobuser

kickoobuser 関数は、1 つ以上の OOB ユーザのアクティブセッションを終了し、Out-of-Band Online

Users リストからユーザを削除します。

必須入力パラメータ：

• op：kickoobuser

• mac：1 つの MAC アドレスまたはカンマ区切りの MAC アドレスのリストを指定します。

（注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

queryuserstime

queryuserstime 関数は、ログインしているユーザの残りのセッション時間を照会します。この関数は、セッションタイムアウトが設定されているロールのログインユーザのリストを返します。必須入力パラメータ： • op：queryuserstime （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0。もう 1 つの  コメントには、IP リストと、各 IP エントリのセッションの残り時間が示されます。 • Failure：エラー文字列

renewuserstime

renewuserstime 関数は、ログインしているインバンドユーザのセッションタイムアウトをセッションごとに更新します。必須入力パラメータ： • op：renewuserstime • list：カンマ区切りの IP アドレスのリストを指定します。サポートされる形式：10.1.10.10、 10.1.10.11、10.1.10.12 （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。

(11)

付録 B API サポート ユーザの操作出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

changeuserrole

changeuserrole 関数は、In-Band ユーザを Online Users リストから削除し、そのユーザの MAC アドレ

スを新しいロールでデバイスフィルタリストに追加することで、ログインしているユーザの In-Band ユーザアクセス権を変更します。必須入力パラメータ： • op：changeuserrole • ip：ログインしているユーザの IP アドレスを指定します。 • role：ユーザの移動先のロールを指定します。（注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

changeloggedinuserrole

changeloggedinuserrole 関数は、ログインしている In-Band ユーザの現在のロールを新しいロールに変更することで、そのユーザのアクセス権を変更します。必須入力パラメータ： • op：changeloggedinuserrole • ip：ログインしているユーザの IP アドレスを指定します。複数のユーザを指定するには、カンマ区切りの IP リストを使用します。 • role：ユーザの新しいロールを指定します。（注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

(12)

付録 B API サポート ゲスト アクセスの操作

ゲスト

アクセスの操作

次の API を使用して、CAM 上でローカルユーザアカウントを作成、削除、および表示できます。 • 「getlocaluserlist」（P.B-12） • 「addlocaluser」（P.B-12） • 「deletelocaluser」（P.B-13）ローカルユーザは、外部認証サーバではなく、CAM によって内部で検証されるユーザです。これらの API は、ダイナミックトークンユーザアクセスを生成するためのゲストアクセスのサポートを目的とし、次の機能を備えています。

• Web ページを使用して Cisco NAC アプライアンス API にアクセスし、ビジターのユーザ名/パス

ワードの組み合せ（[email protected]/jdoe112805 など）を挿入して、ロールを割り当てます（guest1day など）。 • 該当日にゲストアクセスロールに関連付けられたゲストユーザをすべて削除します。 • ゲストアクセスロールに関連付けられたユーザ名をすべてリストします。これらの API は、ゲストユーザアクセス用のダイナミックトークン/パスワード生成のほとんどの実装をサポートし、ゲストロールに対応するゲストユーザの削除を許可します。フロントエンド生成パスワード/トークンを作成する必要があります。アカウンティング用に Cisco NAC アプライアンスに備わっているアカウンティング機能は、RADIUS だけです。

getlocaluserlist

getlocaluserlist 関数は、ローカルユーザアカウントとそのユーザ名およびロール名のリストを返します。必須入力パラメータ： • op：getlocaluserlist （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0。 には返されたユーザ数が示され、これに続いて、  の形式で同じ数のコメントが表示されます。 • Failure：エラー文字列

addlocaluser

addlocaluser 関数は、新しいローカルユーザアカウントを追加します。必須入力パラメータ： • op：addlocaluser • username：新しいローカルユーザアカウントのユーザ名を指定します。 • userpass：新しいローカルユーザアカウントのユーザパスワードを指定します。 • userrole：新しいローカルユーザアカウントのロールを指定します。

(13)

付録 B API サポート OOB スイッチ管理の操作 （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

deletelocaluser

deletelocaluser 関数は、1 つまたはすべてのローカルユーザアカウントを削除します。必須入力パラメータ： • op：deletelocaluser

• qtype：「name」または「all」のデータタイプを指定します。

• qval：一重引用符で囲んだ正確な名前、または「all」を示す空の文字列（‘’）を指定します。（注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0 • Failure：エラー文字列

OOB

スイッチ管理の操作

次の OOB 管理機能を使用して、ユーザが接続するスイッチポートを管理できます。 • 「bounceport」（P.B-13） • 「bounceportbymac」（P.B-14）

bounceport

bounceport 関数は、指定された ID とポート番号に基づいてクライアントが接続するスイッチの OOB ポートをバウンスします。必須入力パラメータ： • op：bounceport

• switch：CAM DB テーブル「switch」に挿入されるスイッチの ID。

• port：バウンスされるスイッチの OOB ポート。

出力パラメータ：

の形式のコメントが返されます。メッセージ値が 0 の場合、操作は成功です。それ以外の場合、エラー文字列が出力されます。

(14)

付録 B API サポート レポートの操作

bounceportbymac

bounceportbymac 関数は、接続したデバイスの MAC アドレスに基づいてクライアントが接続するスイッチの OOB ポートをバウンスします。必須入力パラメータ： • op：bounceportbymac • mac：接続したデバイスの MAC アドレスを提供します。関連付けられているスイッチの接続ポートがバウンスされます。出力パラメータ：  の形式のコメントが返されます。メッセージ値が 0 の場合、操作は成功です。それ以外の場合、エラー文字列が出力されます。

レポートの操作

スクリプトを作成して、情報のリストを編集したり、次のレポート関数を使用してレポートしたりできます。 • 「getversion」（P.B-14） • 「getuserinfo」（P.B-14） • 「getoobuserinfo」（P.B-15） • 「getcleanuserinfo」（P.B-16） • 「getreports」（P.B-16） • 「getuallist」（P.B-20） • 「getualfile」（P.B-20） • 「getcannedreportslist」（P.B-21） • 「getcannedreport」（P.B-21）

getversion

getversion 関数は、CAM のバージョン番号を返します。必須入力パラメータ： • op：getversion 出力パラメータ： •  の形式のコメントが返されます。

getuserinfo

特定の IP アドレス、MAC アドレス、またはユーザ名について、getuserinfo 関数は次のユーザ情報を取得します。 • IP：IPv4 形式の IP アドレス。 • MAC アドレス

(15)

付録 B API サポート レポートの操作 • Name：ユーザ名。 • Provider：LDAP サーバの場合があります。 • Role：ユーザに割り当てられている現在のロール。 • Origrole：ユーザに割り当てられた本来のロール。 • VLAN：本来の VLAN タグ。 • NEWVLAN：現在の VLAN タグ。 • ユーザのシステムのオペレーティングシステム。複数のユーザが条件に一致する場合、システムはユーザのリストを返します。qtype パラメータとして「all」を入力した場合は、すべてのユーザの情報がすべて取得されます。必須入力パラメータ： • op：getuserinfo

• qtype：ip、mac、name、または all の文字列のうちいずれかを指定します。

• qval：qtype パラメータに応じて IP アドレス、MAC アドレス、またはユーザ名を指定します。

「all」を指定した場合は、空の文字列（‘’）を入力します。（注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。出力パラメータ： コメント • Success：メッセージ値 0。 には返されたユーザ数が示され、これに続いて、  の形式で対応する数のコメントが表示されます。 • Failure：エラー文字列

getoobuserinfo

特定の IP アドレス、MAC アドレス、またはユーザ名について、getoobuserinfo 関数は、ログインしている Out-of-Band（OOB; アウトオブバンド）ユーザに関する情報を取得します。または、qtype パラメータに「all」を指定した場合、システムはログインしているすべての OOB ユーザに関する情報のリストを生成します。複数のユーザが条件に一致する場合、システムはユーザのリストを生成します。必須入力パラメータ：

• op：getoobuserinfo

• qtype：ip、mac、name、または all から 1 人または複数のユーザを識別する方式を指定します。

• qval：IP アドレス、MAC アドレス、またはユーザ名を指定します。「all」を指定した場合は、空

の文字列（‘’）を入力します。

(16)

付録 B API サポート レポートの操作 • Success：メッセージ値 0。 には返されたユーザ数が示され、これに続いて、  の形式で相当する数のコメントが表示されます。 • Failure：エラー文字列

getcleanuserinfo

特定の MAC アドレスまたはユーザ名について、getcleanuserinfo 関数は認証済みユーザに関する情報を返します。複数のユーザが条件に一致する場合、システムは認証済みユーザのリストを生成します。必須入力パラメータ： • op：getcleanuserinfo

• qtype：mac、name、または all からユーザを識別する方式を指定します。

• qval：MAC アドレスまたはユーザ名を指定します。「all」を指定した場合は、空の文字列（‘’）を

入力します。出力パラメータ： コメント • Success：メッセージ値 0。 には返されたユーザ数が示され、これに続いて、  の形式で相当する数のコメントが表示されます。 • Failure：エラー文字列

getreports

getreports 関数は、カスタマイズされた内容を含むレポートを返します。また、この関数を使用して、特定のソフトウェアがインストールされているユーザのリストを編集できます。必須入力パラメータ： op：getreports （注）セッションベース認証を使用しない場合は、admin および passwd の引数が必須です。「認証要件」（P.B-2）を参照してください。任意のクエリパラメータ：表 B-1に getreports 関数のクエリパラメータを示します。表 B-1 getreports 関数のクエリパラメータパラメータ名使用可能な値説明 status 次の値のいずれかを指定します。 • any（デフォルト） • success • failure 指定されたステータスについての情報だけをレポートします。 user 文字列。デフォルトは、一重引用符で囲んだ空の文字列（‘’）です。指定されたユーザに関する情報をレポートします。

(17)

付録 B API サポート レポートの操作 agentType 次の値のいずれかを指定します。 • any（デフォルト） • web • win • mac 指定された Cisco NAC アプライアンス Agent タイプに関する情報をレポートします。 ip 1 つの有効な IPv4 アドレス（10.20.30.40 など）。デフォルトは、一重引用符で囲んだ空の文字列です。指定された IP アドレスに関する情報をレポートします。 mac 1 つの有効な MAC アドレス（00:01:12:23:34:45 など）。デフォルトは、一重引用符で囲んだ空の文字列です。指定された MAC アドレスに関する情報をレポートします。 os 次の値のいずれかを指定します。 • 任意の OS を指定するには、一重引用符で囲んだ空の値（''）を入力します（デフォルト）。 • WINDOWS_ALL（Windows（すべて）） • WINDOWS_7_ALL（Windows 7（すべて））

• WINDOWS_7_STARTER（Windows 7 Starter）

• WINDOWS_7_HOME_BASIC（Windows 7 Home Basic） • WINDOWS_7_HOME_PREMIUM（Windows 7 Home Premium） • WINDOWS_7_PROFESSIONAL（Windows 7 Professional） • WINDOWS_7_ENTERPRISE（Windows 7 Enterprise）

• WINDOWS_7_ULTIMATE（Windows 7 Ultimate）

• WINDOWS_7_64_HOME_BASIC（Windows 7 Home Basic x64） • WINDOWS_7_64_HOME_PREMIUM（Windows 7 Home Premium x64） • WINDOWS_7_64_PROFESSIONAL（Windows 7 Professional x64） • WINDOWS_7_64_ENTERPRISE（Windows 7 Enterprise x64）指定された OS に関する情報をレポートします。表 B-1 getreports 関数のクエリパラメータ（続き）パラメータ名使用可能な値説明

(18)

レポートの操作

os（続き） • WINDOWS_7_64_ULTIMATE（Windows 7

Ultimate x64）

• WINDOWS_VISTA_ALL（Windows Vista（すべて））

• WINDOWS_VISTA_HOME_BASIC（Windows Vista Home Basic）

• WINDOWS_VISTA_HOME_PREMIUM

（Windows Vista Home Basic）

• WINDOWS_VISTA_BUSINESS（Windows Vista Business）

• WINDOWS_VISTA_ULTIMATE（Windows Vista Ultimate）

• WINDOWS_VISTA_ENTERPRISE（Windows Vista Enterprise）

• WINDOWS_VISTA_64_HOME_BASIC

（Windows Vista Home Basic x64）

• WINDOWS_VISTA_64_HOME_PREMIUM

（Windows Vista Home Premium x64）

• WINDOWS_VISTA_64_BUSINESS（Windows Vista Business x64） • WINDOWS_VISTA_64_ULTIMATE（Windows Vista Ultimate x64） • WINDOWS_VISTA_64_ENTERPRISE（Windows Vista Enterprise x64） • WINDOWS_XP（Windows XP（すべて））

• WINDOWS_PRO_XP（Windows XP Pro/Home）

• WINDOWS_TPC_XP（Windows XP Tablet PC Edition）

• WINDOWS_MCE_XP（Windows XP Media Center Edition） • MAC_OSX（Mac OS（すべて）） • MAC_OS_10_5（Mac OS 10.5） • MAC_OS_10_6（Mac OS 10.6） • MAC_OS_64_10_6（Mac OS 10.6 x64）指定された OS に関する情報をレポートします。表 B-1 getreports 関数のクエリパラメータ（続き）パラメータ名使用可能な値説明

(19)

レポートの操作

timeRange timeFrom, timeTo

• timeFrom は、次の値のいずれかになります。 – タイムスタンプ（形式：yyyy-mm-dd hh:mm:ss） – 現在より何時間前かを示す負の整数 – past • timeTo は、次の値のいずれかになります。 – タイムスタンプ（形式：yyyy-mm-dd hh:mm:ss） – 現在より何時間前かを示す負の整数 – now – -48, -24（昨日） – -24, now（当該日） – 2007-01-01 00:00:00, 2007-02-28 23:59:59（1 月 1 日から 2 月 28 日までの間）デフォルト：past, now（時間を問わず、すべての可能なレポート）指定した時間範囲内で収集した情報をレポートします。 showText 次の値のいずれかを指定します。 • true：テキストを返します。 • false：テキストを返しません（デフォルト）レポートテキストを返すかどうかを指定します。 orderBy 次の値のいずれかを指定します。 • user • ip • mac • os • time（デフォルト）レポートの編成方法を指定します。 orderDir 次の値のいずれかを指定します。 • asc：昇順を指定します（デフォルト） • desc：降順を指定します。データの昇順または降順を指定します。 instSoft 次の値のいずれかを指定します。 • 一重引用符で囲んだ空の文字列（‘’）は、「any」を示します（デフォルト）。 • AV：アンチウイルス（AntiVirus）がインストール済みであることを指定します。 • AS：アンチスパイウェア（AntiSpyware）がインストール済みであることを指定します。

• UNKNOWN AV/AS：不明の AV/AS を指定します。

このタイプのインストール済みソフトウェアを含むレポートだけに制限します。

表 B-1 getreports 関数のクエリパラメータ（続き）

(20)

付録 B API サポート レポートの操作出力パラメータ： コメント • Success：メッセージ値 0。 には返されたレポート数が示され、これに続いて、  の形式で同じ数のコメントが表示されます。 • Failure：エラー文字列

getuallist

getuallist 関数は、/perfigo/control/data/logs/ual に保存されている XML データファイルのリストを取得します。必須入力パラメータ： • op：getuallist • admin：管理者アカウントのユーザ名 • passwd：管理者アカウントのパスワード

• ip：Cisco NAC アプライアンス API の IP アドレス

(https://<cam-IP-or-hostname>/admin/cisco_api.jsp) 出力パラメータ： コメント • Success：メッセージ値 0。 には返されたファイル数が示され、これに続いて、  の形式で同じ数のファイル名のリストが表示されます。 • Failure：エラー文字列

getualfile

getualfile 関数は、指定した UAL ファイルの内容を表示します。必須入力パラメータ： • op：getUALfile • filename：UAL ファイル名 • admin：管理者アカウントのユーザ名 • passwd：管理者アカウントのパスワード

(https://<cam-IP-or-hostname>/admin/cisco_api.jsp) reqName AV または AS ソフトウェア名の3要件。一重引用符で囲んだ空の文字列は「any」を示します（デフォルト）。このソフトウェア要件を満たすレポートだけに制限します。 reqStatus 次の値のいずれかを指定します。 • any（デフォルト） • success • failure ソフトウェア要件がこのステータスと一致するレポートにだけ制限します（reqName が使用されている場合だけ）。表 B-1 getreports 関数のクエリパラメータ（続き）パラメータ名使用可能な値説明

(21)

付録 B API サポート レポートの操作出力パラメータ：指定したファイルの内容が表示されます。

getcannedreportslist

getcannedreportslist 関数は、既定のディレクトリ/perfigo/control/data/reports にある、既定のすべてのレポートファイルのリストを取得します。必須入力パラメータ： • op：getcannedreportslist • admin：管理者アカウントのユーザ名 • passwd：管理者アカウントのパスワード

(https://<cam-IP-or-hostname>/admin/cisco_api.jsp) 出力パラメータ： コメント • Success：メッセージ値 0。 には返されたレポート数が示され、これに続いて、  の形式で同じ数のコメントが表示されます。 • Failure：エラー文字列

getcannedreport

getcannedreport 関数は、指定した既定のレポートファイルの内容を表示します。必須入力パラメータ： • op：getcannedreport • filename：既定のレポートファイル名 • admin：管理者アカウントのユーザ名 • passwd：管理者アカウントのパスワード

(https://<cam-IP-or-hostname>/admin/cisco_api.jsp)

出力パラメータ：

(22)