Cisco Identity Services Engine Release 1.1.x API リファレンスガイド

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ

このマニュアル内で検索

ご利用いただける言語

Download Options

Book Title

Cisco Identity Services Engine Release 1.1.x API リファレンスガイド

Chapter Title

セッション管理のためのクエリー API の使用

PDF - Complete Book (1.35 MB) PDF - This Chapter (451.0 KB)
View with Adobe Reader on a variety of devices

検索結果

Updated:: 2017年5月29日

章のタイトル：セッション管理のためのクエリー API の使用

セッションカウンタ API コールの使用
単純なセッションリスト API コールの使用
- アクティブなセッションリスト
- 認証セッションリスト
詳細なセッション属性 API コールの使用
古いセッションの削除

セッション管理のためのクエリー API の使用

この章では、Cisco ISE のこのリリースでサポートされる次の個々のセッション管理 REST API コールを使用する方法について例をあげながら説明します。セッション管理 API コールは、Cisco ISE 展開において、Cisco Monitoring ISE ノード内から重要なセッション関連の情報を取得する手段を提供します。

次の項では、API の出力スキーマファイルの例、各 API コール発行の手順、および各 API コールによって返されるデータのサンプルについて説明します。

• 「セッションカウンタ API コールの使用」

• 「単純なセッションリスト API コールの使用」

• 「詳細なセッション属性 API コールの使用」

• 「古いセッションの削除」

セッションカウンタ API コールの使用

次のセッションカウンタ API コールによって、Cisco ISE 展開におけるターゲット Cisco Monitoring ISE ノードのセッション関連情報の現在のカウントをすぐに収集できるようになります。

• アクティブセッション（ActiveCount）

• ポスチャセッション（PostureCount）

• プロファイラセッション（ProfilerCount）

アクティブセッションカウンタ

現在アクティブなすべてのセッションカウントを取得するために ActiveCount API コールを使用できます。ここでは、スキーマファイルの出力例、ActiveCount API コールを呼び出すことにより、すべてのアクティブセッションをカウントする手順、この API コール発行後に返されるアクティブセッションデータのサンプルについて説明します。

ActiveCount API の出力スキーマ

このサンプルスキーマファイルは、ISE のノードのターゲット Monitoring ペルソナでアクティブセッションのカウントを取得するための ActiveCount API コールの出力です。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="sessionCount" type="activeCount"/>

<xs:complexType name="activeCount">

<xs:sequence>

<xs:element name="count" type="xs:int"/>

</xs:sequence>

</xs:complexType>

</xs:schema>

ActiveCount API コールの呼び出し

（注） API コールを発行するターゲットノードが、有効な Cisco Monitoring ISE ノードであることを確認している必要があります。Cisco ISE ノードのペルソナを確認するには、「Cisco Monitoring ISE ノードの確認」を参照してください。

ActiveCount API コールを発行するには、次の手順を実行します。

ステップ 1 ターゲット Cisco Monitoring ISE ノードにログインします。

たとえば、ホスト名が acme123 の Cisco Monitoring ISE ノードに最初にログインする場合、このノードの URL アドレスが次のように表示されます。

https://acme123/admin/LoginAction.do#pageId=com_cisco_xmp_web_page_tmpdash

ステップ 2 「/admin/」コンポーネントを API コールのコンポーネント（/ise/mnt/api/ <specific-api-call>）に置き換えて、ターゲットノードの URL アドレスフィールドに ActiveCount API コールを入力します。

https://acme123/ise/mnt/api/Session/ActiveCount

（注）これらのコールは、大文字小文字を区別するため、ターゲットノードの URL アドレスフィールドに慎重に各 API コールを入力する必要があります。API コール規則での「mnt」の使用は、ターゲット Cisco Monitoring ISE ノードを表します。

ステップ 3 Enter キーを押して API コールを発行します。

ActiveCount API コールから返されるサンプルデータ

次に、ターゲット Cisco Monitoring ISE ノードで ActiveCount API コールを呼び出すときに返されるデータ（アクティブセッション数）を示します。

This XML file does not appear to have any style information associated with it. The document tree is shown below.

</sessionCount>

ポスチャセッションカウンタ

現在アクティブなすべてのポスチャセッションの現在のカウントを取得するために PostureCount API コールを使用できます。ここでは、スキーマファイルの出力例、PostureCount API コールを呼び出すことにより、現在のすべてのアクティブポスチャセッションをカウントする手順、この API コール発行後に返されるポスチャセッションデータのサンプルについて説明します。

PostureCount API の出力スキーマ

このサンプルスキーマファイルは、ターゲット Cisco Monitoring ISE ノードで現在アクティブなポスチャセッションのカウントを取得するための PostureCount API コールの出力です。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="sessionCount" type="postureCount"/>

<xs:complexType name="postureCount">

<xs:sequence>

<xs:element name="count" type="xs:int"/>

</xs:sequence>

</xs:complexType>

</xs:schema>

PostureCount API コールの呼び出し

PostureCount API コールを発行するには、次の手順を実行します。

ステップ 1 ターゲット Cisco Monitoring ISE ノードにログインします。

たとえば、ホスト名が acme123 の Cisco Monitoring ISE ノードに最初にログインする場合、このノードの URL アドレスが次のように表示されます。

https://acme123/admin/LoginAction.do#pageId=com_cisco_xmp_web_page_tmpdash

ステップ 2 「/admin/」コンポーネントを API コールのコンポーネント（/ise/mnt/api/Session/<specific-api-call>）に置き換えて、ターゲットノードの URL アドレスフィールドに PostureCount API コールを入力します。

https://acme123/ise/mnt/api/Session/PostureCount

ステップ 3 Enter キーを押して API コールを発行します。

PostureCount API コールから返されるサンプルデータ

次に、ターゲット Cisco Monitoring ISE ノードで PostureCount API コールを呼び出すときに返されるデータ（現在アクティブなポスチャセッション数）を示します。

This XML file does not appear to have any style information associated with it. The document tree is shown below.

</sessionCount>

プロファイラセッションカウンタ

現在アクティブなすべてのプロファイラセッションカウントを取得するために ProfilerCount API コールを使用できます。ここでは、スキーマファイルの出力例、ProfilerCount API コールを呼び出すことにより、現在のすべてのアクティブプロファイラセッションをカウントする手順、この API コール発行後に返されるプロファイラセッションデータのサンプルについて説明します。

ProfilerCount API の出力スキーマ

このサンプルスキーマファイルは、ターゲット Cisco Monitoring ISE ノードで現在アクティブなプロファイラセッションのカウントを取得するための ProfilerCount API コールの出力です。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="sessionCount" type="profilerCount"/>

<xs:complexType name="profilerCount">

<xs:sequence>

<xs:element name="count" type="xs:int"/>

</xs:sequence>

</xs:complexType>

</xs:schema>

ProfilerCount API コールの呼び出し

ProfilerCount API コールを発行するには、次の手順を実行します。

ステップ 1 ターゲット Cisco Monitoring ISE ノードにログインします。

たとえば、ホスト名が acme123 の Cisco Monitoring ISE ノードに最初にログインする場合、このノードの URL アドレスが次のように表示されます。

https://acme123/admin/LoginAction.do#pageId=com_cisco_xmp_web_page_tmpdash

ステップ 2 「/admin/」コンポーネントを API コールのコンポーネント（/ise/mnt/api/Session/<specific-api-call>）に置き換えて、ターゲットノードの URL アドレスフィールドに ProfilerCount API コールを入力します。

https://acme123/ise/mnt/api/Session/ProfilerCount

（注）これらのコールは、大文字小文字を区別するため、ターゲットノードの URL アドレスフィールドに慎重に各 API コールを入力する必要があります。API コール規則での「mnt」の使用は、Cisco Monitoring ISE ノードを表します。

ステップ 3 Enter キーを押して API コールを発行します。

ProfilerCount API コールから返されるサンプルデータ

次に、ターゲット Cisco Monitoring ISE ノードで ProfilerCount API コールを呼び出すときに返されるデータ（現在アクティブなプロファイラセッション数）を示します。

This XML file does not appear to have any style information associated with it. The document tree is shown below.

</sessionCount>

単純なセッションリスト API コールの使用

次の単純なセッションリスト API コールによって、Cisco ISE 展開におけるターゲット Cisco Monitoring ISE ノードの現在のアクティブセッションに関連付けられた MAC アドレス、ネットワークアクセススイッチ（NAS）の IP アドレス、ユーザ名、セッション ID などのセッション関連の情報をすぐに収集できるようになります。

• アクティブなセッションリスト（ActiveList）

• 認証セッションリスト（AuthList）

アクティブなセッションリスト

現在アクティブなすべてのセッションをリストするには ActiveList API 呼び出しを使用できます。ここでは、スキーマファイルの出力例、ActiveList API コールを呼び出すことにより、すべてのアクティブセッションをリストする手順、この API コール発行後に返されるアクティブセッション関連のデータのサンプルについて説明します。

（注） Cisco ISE のこのリリースでは、アクティブな認証済みエンドポイントセッションの表示可能な最大数は、100,000 に制限されています。

ActiveList API の出力スキーマ

このサンプルスキーマファイルは、ターゲット Cisco Monitoring ISE ノードで現在アクティブなセッション（およびセッション関連情報）のリストを取得するための ActiveList API コールの出力です。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="activeSessionList" type="simpleActiveSessionList"/>

<xs:complexType name="simpleActiveSessionList">

<xs:sequence>

<xs:element name="activeSession" type="simpleActiveSession" minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

<xs:attribute name="noOfActiveSession" type="xs:int" use="required"/>

</xs:complexType>

<xs:complexType name="simpleActiveSession">

<xs:sequence>

<xs:element name="user_name" type="xs:string" minOccurs="0"/>

<xs:element name="calling_station_id" type="xs:string" minOccurs="0"/>

<xs:element name="nas_ip_address" type="xs:string" minOccurs="0"/>

<xs:element name="acct_session_id" type="xs:string" minOccurs="0"/>

<xs:element name="audit_session_id" type="xs:string" minOccurs="0"/>

<xs:element name="server" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

</xs:schema>

ActiveList API コールの呼び出し

ActiveList API コールを発行するには、次の手順を実行します。

ステップ 1 ターゲット Cisco Monitoring ISE ノードにログインします。

たとえば、ホスト名が acme123 の Cisco Monitoring ISE ノードに最初にログインする場合、このノードの URL アドレスが次のように表示されます。

https://acme123/admin/LoginAction.do#pageId=com_cisco_xmp_web_page_tmpdash

ステップ 2 「/admin/」コンポーネントを API コールのコンポーネント（/ise/mnt/api/Session/<specific-api-call>）に置き換えて、ターゲットノードの URL アドレスフィールドに ActiveList API コールを入力します。

https://acme123/ise/mnt/api/Session/ActiveList

（注）これらのコールは、大文字小文字を区別するため、ターゲットノードの URL アドレスフィールドに慎重に各 API 呼び出しを入力する必要があります。API コール規則での「mnt」の使用は、Cisco Monitoring ISE ノードを表します。

ステップ 3 Enter キーを押して API コールを発行します。

ActiveList API コールから返されるサンプルデータ

次に、ターゲット Cisco Monitoring ISE ノードで ActiveList API コールを呼び出すときにアクティブセッションのリストから返されるセッション関連データを示します。

This XML file does not appear to have any style information associated with it. The document tree is shown below.

<calling_station_id>00:0C:29:FA:EF:0A</calling_station_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<calling_station_id>70:5A:B6:68:F7:CC</calling_station_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>tom_wolfe</user_name>

<calling_station_id>00:14:BF:5A:0C:03</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000032</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>graham_hancock</user_name>

<calling_station_id>00:50:56:8E:28:BD</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>0000002C</acct_session_id>

<audit_session_id>0ACB6BA10000002A165FD0C8</audit_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>ipepvpnuser</user_name>

<calling_station_id>172.23.130.89</calling_station_id>

<nas_ip_address>10.203.107.45</nas_ip_address>

<acct_session_id>A2000070</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

</activeSessionList>

認証セッションリスト

現在アクティブなすべての認証セッションのリストを取得するために AuthList API コールを使用できます。ここでは、スキーマファイルの出力例、AuthList API コールを呼び出すことにより、現在のすべてのアクティブな認証セッションをリストする手順、この API コール発行後に返されるアクティブな認証セッションのサンプルについて説明します。

（注） Cisco ISE のこのリリースでは、アクティブな認証済みエンドポイントセッションの表示可能な最大数は、100,000 に制限されています。

AuthList API の出力スキーマ

このサンプルスキーマファイルは、ターゲット Cisco Monitoring ISE ノードでの、指定した期間内（または「null/null」パラメータを使用して期間を指定しない場合）現在アクティブなすべての認証セッションのリストを取得するための AuthList API コールの出力です。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="activeSessionList" type="simpleActiveSessionList"/>

<xs:complexType name="simpleActiveSessionList">

<xs:sequence>

<xs:element name="activeSession" type="simpleActiveSession" minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

<xs:attribute name="noOfActiveSession" type="xs:int" use="required"/>

</xs:complexType>

<xs:complexType name="simpleActiveSession">

<xs:sequence>

<xs:element name="user_name" type="xs:string" minOccurs="0"/>

<xs:element name="calling_station_id" type="xs:string" minOccurs="0"/>

<xs:element name="nas_ip_address" type="xs:string" minOccurs="0"/>

<xs:element name="acct_session_id" type="xs:string" minOccurs="0"/>

<xs:element name="audit_session_id" type="xs:string" minOccurs="0"/>

<xs:element name="server" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

</xs:schema>

AuthList API コールの呼び出し

AuthList API コールを発行するには、次の手順を実行します。

ステップ 1 ターゲット Cisco Monitoring ISE ノードにログインします。

たとえば、ホスト名が acme123 の Cisco Monitoring ISE ノードに最初にログインする場合、このノードの URL アドレスが次のように表示されます。

https://acme123/admin/LoginAction.do#pageId=com_cisco_xmp_web_page_tmpdash

ステップ 2 「/admin/」コンポーネントを API コールのコンポーネント（/ise/mnt/api/Session/<specific-api-call>）に置き換えて、ターゲットノードの URL アドレスフィールドに AuthList API コールを入力します。

（注）次の 2 種類の例では、定義済みの開始時刻パラメータおよび null パラメータを使用し、開始時刻以降に認証された現在アクティブなセッションのリストを表示します。2 番目の例は、現在アクティブなすべての認証済みセッションのリストを表示する「null/null」パラメータを使用します。この API コールに対する 4 種類のパラメータ設定の例については、「AuthList API コールから返されるサンプルデータ」を参照してください。

https://acme123/ise/mnt/api/Session/AuthList/2010-12-14 15:33:15/null

https://acme123/ise/mnt/api/Session/AuthList/null/null

ステップ 3 Enter キーを押して API コールを発行します。

AuthList API コールから返されるサンプルデータ

次に、サポートされているパラメータオプションの 1 つを使用して、ターゲット Cisco Monitoring ISE ノードで AuthList API コールを呼び出すときに返される、現在アクティブな認証済みセッションのリストを示します。

null/null オプションの使用

This XML file does not appear to have any style information associated with it. The document tree is shown below.

<user_name>ipepwlcuser</user_name>

<calling_station_id>00:26:82:7B:D2:51</calling_station_id>

<nas_ip_address>10.203.107.10</nas_ip_address>

<audit_session_id>0acb6b0c000000174D07F487</audit_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>tom_wolfe</user_name>

<calling_station_id>00:50:56:8E:28:BD</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000035</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>graham_hancock</user_name>

<calling_station_id>00:14:BF:5A:0C:03</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000033</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

</activeSessionList>

endtime/null オプションの使用

This XML file does not appear to have any style information associated with it. The document tree is shown below.

<user_name>ipepwlcuser</user_name>

<calling_station_id>00:26:82:7B:D2:51</calling_station_id>

<nas_ip_address>10.203.107.10</nas_ip_address>

<audit_session_id>0acb6b0c0000001F4D08085A</audit_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>hunter_thompson</user_name>

<calling_station_id>00:50:56:8E:28:BD</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000035</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>bob_ludlum</user_name>

<calling_station_id>00:14:BF:5A:0C:03</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000033</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

</activeSessionList>

null/starttime オプションの使用

This XML file does not appear to have any style information associated with it. The document tree is shown below.

<user_name>ipepwlcuser</user_name>

<calling_station_id>00:26:82:7B:D2:51</calling_station_id>

<nas_ip_address>10.203.107.10</nas_ip_address>

<audit_session_id>0acb6b0c0000001F4D08085A</audit_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>bob_ludlum</user_name>

<calling_station_id>00:50:56:8E:28:BD</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000035</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>tom_wolfe</user_name>

<calling_station_id>00:14:BF:5A:0C:03</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000033</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

</activeSessionList>

starttime/endtime オプションの使用

This XML file does not appear to have any style information associated with it. The document tree is shown below.

<user_name>ipepwlcuser</user_name>

<calling_station_id>00:26:82:7B:D2:51</calling_station_id>

<nas_ip_address>10.203.107.10</nas_ip_address>

<audit_session_id>0acb6b0c0000001F4D08085A</audit_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>graham_hancock</user_name>

<calling_station_id>00:50:56:8E:28:BD</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000035</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

<user_name>hunter_thompson</user_name>

<calling_station_id>00:14:BF:5A:0C:03</calling_station_id>

<nas_ip_address>10.203.107.161</nas_ip_address>

<acct_session_id>00000033</acct_session_id>

<server>HAREESH-R6-1-PDP2</server>

</activeSession>

</activeSessionList>

詳細なセッション属性 API コールの使用

次の詳細なセッション属性 API コールによって、次のようなキー情報の最新のセッションをすぐに検索することができるようになります。

• MAC アドレスセッションの検索（MACAddress）

• ユーザ名のセッションの検索（UserName）

• NAS IP アドレスセッションの検索（ターゲット Monitoring ISE ノードに関連付けられた IP アドレス）

• エンドポイントの IP アドレスのセッションの検索（EndPointIPAddress）

MAC アドレスセッションの検索

現在のアクティブなセッションから指定された MAC アドレスを取得するために MACAddress API コールを使用できます。ここでは、スキーマファイルの出力例、MACAddress API コールを呼び出すことより、指定された MAC アドレスが含まれる最新のアクティブセッションに対応するノードデータベースを検索する手順、API コールの後に返された MAC アドレス関連データのサンプルについて説明します。この API コールは、ノードデータベーステーブルから供給されるさまざまセッション関連の情報をリストします。

MACAddress API の出力スキーマ

このサンプルスキーマファイルは、ターゲット Cisco Monitoring ISE ノードで現在アクティブなセッションから指定された MAC アドレスを取得するための MACAddress API コールの出力です。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="sessionParameters" type="restsdStatus"/>

<xs:complexType name="restsdStatus">

<xs:sequence>

<xs:element name="passed" type="xs:anyType" minOccurs="0"/>

<xs:element name="failed" type="xs:anyType" minOccurs="0"/>

<xs:element name="user_name" type="xs:string" minOccurs="0"/>

<xs:element name="nas_ip_address" type="xs:string" minOccurs="0"/>

<xs:element name="failure_reason" type="xs:string" minOccurs="0"/>

<xs:element name="calling_station_id" type="xs:string" minOccurs="0"/>

<xs:element name="nas_port" type="xs:string" minOccurs="0"/>

<xs:element name="identity_group" type="xs:string" minOccurs="0"/>

<xs:element name="network_device_name" type="xs:string" minOccurs="0"/>

<xs:element name="acs_server" type="xs:string" minOccurs="0"/>

<xs:element name="authen_protocol" type="xs:string" minOccurs="0"/>

<xs:element name="framed_ip_address" type="xs:string" minOccurs="0"/>

<xs:element name="network_device_groups" type="xs:string" minOccurs="0"/>

<xs:element name="access_service" type="xs:string" minOccurs="0"/>

<xs:element name="auth_acs_timestamp" type="xs:dateTime" minOccurs="0"/>

<xs:element name="authentication_method" type="xs:string" minOccurs="0"/>

<xs:element name="execution_steps" type="xs:string" minOccurs="0"/>

<xs:element name="radius_response" type="xs:string" minOccurs="0"/>

<xs:element name="audit_session_id" type="xs:string" minOccurs="0"/>

<xs:element name="nas_identifier" type="xs:string" minOccurs="0"/>

<xs:element name="nas_port_id" type="xs:string" minOccurs="0"/>

<xs:element name="nac_policy_compliance" type="xs:string" minOccurs="0"/>

<xs:element name="auth_id" type="xs:long" minOccurs="0"/>

<xs:element name="auth_acsview_timestamp" type="xs:dateTime" minOccurs="0"/>

<xs:element name="message_code" type="xs:string" minOccurs="0"/>

<xs:element name="acs_session_id" type="xs:string" minOccurs="0"/>

<xs:element name="service_selection_policy" type="xs:string" minOccurs="0"/>

<xs:element name="authorization_policy" type="xs:string" minOccurs="0"/>

<xs:element name="identity_store" type="xs:string" minOccurs="0"/>

<xs:element name="response" type="xs:string" minOccurs="0"/>

<xs:element name="service_type" type="xs:string" minOccurs="0"/>

<xs:element name="cts_security_group" type="xs:string" minOccurs="0"/>

<xs:element name="use_case" type="xs:string" minOccurs="0"/>

<xs:element name="cisco_av_pair" type="xs:string" minOccurs="0"/>

<xs:element name="ad_domain" type="xs:string" minOccurs="0"/>

<xs:element name="acs_username" type="xs:string" minOccurs="0"/>

<xs:element name="radius_username" type="xs:string" minOccurs="0"/>

<xs:element name="nac_role" type="xs:string" minOccurs="0"/>

<xs:element name="nac_username" type="xs:string" minOccurs="0"/>

<xs:element name="nac_posture_token" type="xs:string" minOccurs="0"/>

<xs:element name="nac_radius_is_user_auth" type="xs:string" minOccurs="0"/>

<xs:element name="selected_posture_server" type="xs:string" minOccurs="0"/>

<xs:element name="selected_identity_store" type="xs:string" minOccurs="0"/>

<xs:element name="authentication_identity_store" type="xs:string" minOccurs="0"/>

<xs:element name="azn_exp_pol_matched_rule" type="xs:string" minOccurs="0"/>

<xs:element name="ext_pol_server_matched_rule" type="xs:string" minOccurs="0"/>

<xs:element name="grp_mapping_pol_matched_rule" type="xs:string" minOccurs="0"/>

<xs:element name="identity_policy_matched_rule" type="xs:string" minOccurs="0"/>

<xs:element name="nas_port_type" type="xs:string" minOccurs="0"/>

<xs:element name="query_identity_stores" type="xs:string" minOccurs="0"/>

<xs:element name="selected_azn_profiles" type="xs:string" minOccurs="0"/>

<xs:element name="sel_exp_azn_profiles" type="xs:string" minOccurs="0"/>

<xs:element name="selected_query_identity_stores" type="xs:string" minOccurs="0"/>

<xs:element name="eap_tunnel" type="xs:string" minOccurs="0"/>

<xs:element name="tunnel_details" type="xs:string" minOccurs="0"/>

<xs:element name="cisco_h323_attributes" type="xs:string" minOccurs="0"/>

<xs:element name="cisco_ssg_attributes" type="xs:string" minOccurs="0"/>

<xs:element name="other_attributes" type="xs:string" minOccurs="0"/>

<xs:element name="response_time" type="xs:long" minOccurs="0"/>

<xs:element name="nad_failure" type="xs:anyType" minOccurs="0"/>

<xs:element name="destination_ip_address" type="xs:string" minOccurs="0"/>

<xs:element name="acct_id" type="xs:long" minOccurs="0"/>

<xs:element name="acct_acs_timestamp" type="xs:dateTime" minOccurs="0"/>

<xs:element name="acct_acsview_timestamp" type="xs:dateTime" minOccurs="0"/>

<xs:element name="acct_session_id" type="xs:string" minOccurs="0"/>

<xs:element name="acct_status_type" type="xs:string" minOccurs="0"/>

<xs:element name="acct_session_time" type="xs:long" minOccurs="0"/>

<xs:element name="acct_input_octets" type="xs:string" minOccurs="0"/>

<xs:element name="acct_output_octets" type="xs:string" minOccurs="0"/>

<xs:element name="acct_input_packets" type="xs:long" minOccurs="0"/>

<xs:element name="acct_output_packets" type="xs:long" minOccurs="0"/>

<xs:element name="acct_class" type="xs:string" minOccurs="0"/>

<xs:element name="acct_terminate_cause" type="xs:string" minOccurs="0"/>

<xs:element name="acct_multi_session_id" type="xs:string" minOccurs="0"/>

<xs:element name="acct_authentic" type="xs:string" minOccurs="0"/>

<xs:element name="termination_action" type="xs:string" minOccurs="0"/>

<xs:element name="session_timeout" type="xs:string" minOccurs="0"/>

<xs:element name="idle_timeout" type="xs:string" minOccurs="0"/>

<xs:element name="acct_interim_interval" type="xs:string" minOccurs="0"/>

<xs:element name="acct_delay_time" type="xs:string" minOccurs="0"/>

<xs:element name="event_timestamp" type="xs:string" minOccurs="0"/>

<xs:element name="acct_tunnel_connection" type="xs:string" minOccurs="0"/>

<xs:element name="acct_tunnel_packet_lost" type="xs:string" minOccurs="0"/>

<xs:element name="security_group" type="xs:string" minOccurs="0"/>

<xs:element name="cisco_h323_setup_time" type="xs:dateTime" minOccurs="0"/>

<xs:element name="cisco_h323_connect_time" type="xs:dateTime" minOccurs="0"/>

<xs:element name="cisco_h323_disconnect_time" type="xs:dateTime" minOccurs="0"/>

<xs:element name="framed_protocol" type="xs:string" minOccurs="0"/>

<xs:element name="started" type="xs:anyType" minOccurs="0"/>

<xs:element name="stopped" type="xs:anyType" minOccurs="0"/>

<xs:element name="ckpt_id" type="xs:long" minOccurs="0"/>

<xs:element name="type" type="xs:long" minOccurs="0"/>

<xs:element name="nad_acsview_timestamp" type="xs:dateTime" minOccurs="0"/>

<xs:element name="vlan" type="xs:string" minOccurs="0"/>

<xs:element name="dacl" type="xs:string" minOccurs="0"/>

<xs:element name="authentication_type" type="xs:string" minOccurs="0"/>

<xs:element name="interface_name" type="xs:string" minOccurs="0"/>

<xs:element name="reason" type="xs:string" minOccurs="0"/>

<xs:element name="endpoint_policy" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

</xs:schema>

MACAddress API コールの呼び出し

MACAddress API コールを発行するには、次の手順を実行します。

ステップ 1 ターゲット Cisco Monitoring ISE ノードにログインします。

たとえば、ホスト名が acme123 の Cisco Monitoring ISE ノードに最初にログインする場合、このノードの URL アドレスが次のように表示されます。

https://acme123/admin/LoginAction.do#pageId=com_cisco_xmp_web_page_tmpdash

ステップ 2 「/admin/」コンポーネントを API コールのコンポーネント（/ise/mnt/api/<specific-api-call>/<macaddress>）に置き換えて、ターゲットノードの URL アドレスフィールドに MACAddress API コールを入力します。

https://acme123/ise/mnt/api/Session/MACAddress/0A:0B:0C:0D:0E:0F

（注） XX:XX:XX:XX:XX:XX 形式を使用して MAC アドレスを指定していることを確認します。

ステップ 3 Enter キーを押して API コールを発行します。

MACAddress API コールから返されるサンプルデータ

This XML file does not appear to have any style information associated with it. The document tree is shown below.

<failed xsi:type="xs:boolean">false</failed>

<user_name>hunter_thompson</user_name>

<nas_ip_address>10.203.107.161</nas_ip_address>

<calling_station_id>00:14:BF:5A:0C:03</calling_station_id>

<nas_port>50115</nas_port>

<identity_group>Profiled</identity_group>

<network_device_name>Core-Switch</network_device_name>

<acs_server>HAREESH-R6-1-PDP2</acs_server>

<authen_protocol>Lookup</authen_protocol>

<network_device_groups>

Device Type#All Device Types,Location#All Locations

</network_device_groups>

<access_service>RADIUS</access_service>

<auth_acs_timestamp>2010-12-15T02:11:12.359Z</auth_acs_timestamp>

<authentication_method>mab</authentication_method>

<execution_steps>

11001,11017,11027,15008,15048,15004,15041,15004,15013,24209,24211,22037,15036,15048,15048,
15004,15016,11022,11002

</execution_steps>

<audit_session_id>0ACB6BA1000000351BBFBF8B</audit_session_id>

<nas_port_id>GigabitEthernet1/0/15</nas_port_id>

<nac_policy_compliance>Pending</nac_policy_compliance>

<auth_id>1291240762077361</auth_id>

<auth_acsview_timestamp>2010-12-15T02:11:12.360Z</auth_acsview_timestamp>

<message_code>5200</message_code>

<acs_session_id>HAREESH-R6-1-PDP2/81148292/681</acs_session_id>

<service_selection_policy>MAB</service_selection_policy>

<identity_store>Internal Hosts</identity_store>

{UserName=00-14-BF-5A-0C-03; User-Name=00-14-BF-5A-0C-03;
State=ReauthSession:0ACB6BA1000000351BBFBF8B;
Class=CACS:0ACB6BA1000000351BBFBF8B:HAREESH-R6-1-PDP2/81148292/681;
Termination-Action=RADIUS-Request; cisco-av-pair=url-redirect-acl=ACL-WEBAUTH-REDIRECT;
cisco-av-pair=url-redirect=https://HAREESH-R6-1-PDP2.cisco.com:8443/guestportal/gateway?se
ssionId=0ACB6BA1000000351BBFBF8B&action=cwa;
cisco-av-pair=ACS:CiscoSecure-Defined-ACL=#ACSACL#-IP-ACL-DENY-4ced8390; }

</response>

<service_type>Call Check</service_type>

<use_case>Host Lookup</use_case>

<cisco_av_pair>audit-session-id=0ACB6BA1000000351BBFBF8B</cisco_av_pair>

<acs_username>00:14:BF:5A:0C:03</acs_username>

<radius_username>00:14:BF:5A:0C:03</radius_username>

<selected_identity_store>Internal Hosts</selected_identity_store>

<authentication_identity_store>Internal Hosts</authentication_identity_store>

<identity_policy_matched_rule>Default</identity_policy_matched_rule>

<nas_port_type>Ethernet</nas_port_type>

<selected_azn_profiles>CWA</selected_azn_profiles>

<other_attributes>

ConfigVersionId=44,DestinationIPAddress=10.203.107.162,DestinationPort=1812,Protocol=Radiu
s,Framed-MTU=1500,EAP-Key-Name=,CPMSessionID=0ACB6BA1000000351BBFBF8B,CPMSessionID=0ACB6BA
1000000351BBFBF8B,EndPointMACAddress=00-14-BF-5A-0C-03,HostIdentityGroup=Endpoint Identity
Groups:Profiled,Device Type=Device Type#All Device Types,Location=Location#All
Locations,Model Name=Unknown,Software Version=Unknown,Device IP
Address=10.203.107.161,Called-Station-ID=04:FE:7F:7F:C0:8F

</other_attributes>

<response_time>77</response_time>

<acct_id>1291240762077386</acct_id>

<acct_acs_timestamp>2010-12-15T02:12:30.779Z</acct_acs_timestamp>

<acct_acsview_timestamp>2010-12-15T02:12:30.780Z</acct_acsview_timestamp>

<acct_session_id>00000038</acct_session_id>

<acct_status_type>Interim-Update</acct_status_type>

<acct_session_time>78</acct_session_time>

<acct_input_octets>13742</acct_input_octets>

<acct_output_octets>6277</acct_output_octets>

<acct_input_packets>108</acct_input_packets>

<acct_output_packets>66</acct_output_packets>

<acct_class>

CACS:0ACB6BA1000000351BBFBF8B:HAREESH-R6-1-PDP2/81148292/681

</acct_class>

<acct_delay_time>0</acct_delay_time>

<started xsi:type="xs:boolean">false</started>

<stopped xsi:type="xs:boolean">false</stopped>

</sessionParameters>

ユーザ名のセッションの検索

現在のアクティブなセッションから指定されたユーザ名を取得するために UserName API コールを使用できます。ここでは、スキーマファイルの出力例、UserName API コールを呼び出すことより、指定されたユーザ名が含まれる最新のアクティブセッションに対応するノードデータベースを検索する手順、API コールの後に返されたユーザ名関連データのサンプルについて説明します。この API は、ノードデータベーステーブルから供給されるさまざまセッション関連の情報をリストします。

UserName API の出力スキーマ

このサンプルスキーマファイルは、ターゲット Cisco Monitoring ISE ノードで現在アクティブなセッションから指定されたユーザ名を取得するための UserName API コールの出力です。