Cisco Unified Communications Manager Express 4.3 システム アドミニストレータ ガイド
XML API の設定
XML API の設定
発行日;2012/01/07 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 11MB) | フィードバック

目次

XML API の設定

内容

XML API に関する情報

XML API とは

IXI を使用した XML API の提供

XML API の設定方法

XML トランスポート パラメータの定義

XML アプリケーションのパラメータの定義

XML アクセスの認証の定義

XML イベント テーブルのパラメータの定義

XML インターフェイスのトラブルシューティング

XML API の設定例

XML トランスポートのパラメータの例

XML アプリケーションのパラメータの例

XML 認証の例

XML イベント テーブルの例

関連情報

その他の資料

関連マニュアル

テクニカル サポート

XML API の機能情報

XML API の設定

Revised: March 3, 2008

 

この章では、Cisco Unified Communications Manager Express(Cisco Unified CME)で利用可能な eXtensible Markup Language(XML)Application Programming Interface(API; アプリケーション プログラミング インターフェイス)のサポートについて説明します。

この章で説明する機能について

この章で説明している機能の一部は、ご使用のバージョンの Cisco Unified CME でサポートされていない場合があります。それぞれの機能がサポートされているバージョンの一覧については、「XML API の機能情報」を参照してください。

XML API に関する情報

XML API を有効にするには、次の概念を理解しておく必要があります。

「XML API とは」

「IXI を使用した XML API の提供」

XML API とは

XML API は、Cisco Unified CME にインターフェイスを提供します。この API を利用すると、外部の NMS(Network Management System; ネットワーク管理システム)で Cisco Unified CME の動作を設定および監視できます。

IXI を使用した XML API の提供

Cisco Unified CME の以前のバージョンの XML インターフェイスでは、HTTP ポートを使用する設定機能と管理機能を提供していました。この XML インターフェイスは HTTP サーバ プロセスの下で実行され、複数の着信 XML 要求をオンデマンドで同時に解析し、処理していました。

Cisco Unified CME 4.0 以降のバージョンでは、XML インターフェイスは Cisco IOS XML Infrastructure(IXI)を通じて提供されます。このインフラストラクチャでは、パーサーとトランスポート層がアプリケーションから独立しています。このようにモジュラ式になっているため、スケーラビリティが得られ、将来の XML サポートの開発が可能になります。Cisco Unified CME 4.0 以降のバージョンでは、すべての Cisco Unified CME 機能で XML をサポートします。

XML API の設定方法

この項では、次の作業について取り上げます。

「XML トランスポート パラメータの定義」

「XML アプリケーションのパラメータの定義」

「XML アクセスの認証の定義」

「XML イベント テーブルのパラメータの定義」

「XML インターフェイスのトラブルシューティング」


) 以前に XML インターフェイスで使用されていた log passwordxmltestxmlschema、および xmlthread の各 Cisco IOS コマンドは、有効ではなくなりました。


XML トランスポート パラメータの定義

XML トランスポートの方式と関連パラメータを定義するには、次の手順を実行します。

要約手順

1. enable

2. configure terminal

3. ip http server

4. ixi transport http

5. response size fragment- size

6. request outstanding number

7. request timeout seconds

8. no shutdown

9. end

詳細手順

コマンドまたはアクション
目的

ステップ 1

enable

 

Router> enable

特権 EXEC モードを有効にします。

プロンプトが表示されたら、パスワードを入力します。

ステップ 2

configure terminal

 

Router# configure terminal

global 設定モードを開始します。

ステップ 3

ip http server

 

Router(config)# ip http server

ローカル Cisco Unified CME ルータの Cisco Web ブラウザ ユーザ インターフェイスを有効にします。

ステップ 4

ixi transport http

 

Router(config)# ixi transport http

XML トランスポートの方式を指定し、XML トランスポート設定モードを開始します。

http :HTTP トランスポート。

ステップ 5

response size fragment-size

 

Router(conf-xml-trans)# response size 8

応答バッファのサイズを設定します。

fragment-size :応答バッファのフラグメントのサイズ(KB 単位)。値の範囲は、トランスポート タイプおよびプラットフォームに応じて制限されます。有効となる値の範囲については、CLI のヘルプを参照してください。

ステップ 6

request outstanding number

 

Router(conf-xml-trans)# request outstanding 2

このトランスポート タイプで許容される未解決要求の最大数を設定します。

number :要求の数。値の範囲は、トランスポート タイプおよびプラットフォームに応じて制限されます。有効となる値の範囲については、CLI のヘルプを参照してください。

ステップ 7

request timeout seconds

 

Router(conf-xml-trans)# request timeout 30

要求の処理をタイムアウトにするまでの待機秒数を設定します。

seconds :秒数。値の範囲は 0 ~ 60 です。

ステップ 8

no shutdown

 

Router(conf-xml-trans)# no shutdown

HTTP トランスポートを有効にします。

ステップ 9

end

 

Router(config-xml-app)# end

特権 EXEC モードに戻ります。

XML アプリケーションのパラメータの定義

XML アプリケーションとの通信に適用される応答タイムアウトを設定するには、次の手順を実行します。transport 設定モードで設定した値は上書きされます。

要約手順

1. enable

2. configure terminal

3. ixi application cme

4. response timeout { -1 | seconds }

5. no shutdown

6. end

詳細手順

コマンドまたはアクション
目的

ステップ 1

enable

 

Router> enable

特権 EXEC モードを有効にします。

プロンプトが表示されたら、パスワードを入力します。

ステップ 2

configure terminal

 

Router# configure terminal

global 設定モードを開始します。

ステップ 3

ixi application cme

 

Router(config)# ixi application cme

XML アプリケーション設定モードを開始し、Cisco Unified CME アプリケーションの Cisco IOS XML インフラストラクチャ パラメータを設定します。


) このコマンドは、Cisco Unified CME XML サーバの URL を http://<routerIPaddress>/ios_xml_app/cme と定義します。


ステップ 4

response timeout { -1 | seconds }

 

Router(config-xml-app) response timeout 30

XML アプリケーションへの応答にタイムアウトを設定して、IXI トランスポート レベルのタイムアウトを上書きします。

-1 :アプリケーション固有のタイムアウトを指定しません。これはデフォルトです。

seconds :タイムアウトの長さ(秒単位)。値の範囲は 0 ~ 60 です。

ステップ 5

no shutdown

 

Router(conf-xml-app)# no shutdown

アプリケーションとの XML 通信を有効にします。

ステップ 6

end

 

Router(config-xml-app)# end

特権 EXEC モードに戻ります。

XML アクセスの認証の定義

XML アクセス用にユーザを認証するには、次の手順を実行します。

要約手順

1. enable

2. configure terminal

3. telephony-service

4. xml user user-name password password privilege-level

5. end

詳細手順

コマンドまたはアクション
目的

ステップ 1

enable

 

Router> enable

特権 EXEC モードを有効にします。

プロンプトが表示されたら、パスワードを入力します。

ステップ 2

configure terminal

 

Router# configure terminal

global 設定モードを開始します。

ステップ 3

telephony-service

 

Router(config)# telephony-service

telephony-service 設定モードを開始します。

ステップ 4

xml user user-name password password privilege-level

 

Router(config-telephony)# xml user user23 password 3Rs92uzQ 15

権限のあるユーザを定義します。

user-name :権限のあるユーザのユーザ名。

password :アクセスに使用するパスワード。

privilege-level :このユーザに付与する Cisco IOS コマンドへのアクセス レベル。XML を通じて実行できるのは、これと同等またはそれ以下のレベルのコマンドだけになります。値の範囲は 0 ~ 15 です。

ステップ 5

end

 

Router(config-telephony)# end

特権 EXEC モードに戻ります。

XML イベント テーブルのパラメータの定義

XML イベント テーブルは、電話機の登録/登録解除や内線電話のステータスなど、キャプチャされたタイムスタンプ付きイベントを格納するための内部バッファです。1 イベントはテーブル内の 1 エントリに相当します。XML イベント テーブルに格納するイベント(つまりエントリ)の最大数、およびテーブルから削除されるまでのイベントの保持期間を設定するには、次の手順を実行します。

要約手順

1. enable

2. configure terminal

3. telephony-service

4. log table max-size number

5. log table retain-timer minutes

6. end

7. show fb-its-log

8. clear telephony-service xml-event-log

詳細手順

コマンドまたはアクション
目的

ステップ 1

enable

 

Router> enable

特権 EXEC モードを有効にします。

プロンプトが表示されたら、パスワードを入力します。

ステップ 2

configure terminal

 

Router# configure terminal

global 設定モードを開始します。

ステップ 3

telephony-service

 

Router(config)#

telephony-service 設定モードを開始します。

ステップ 4

log table max-size number

 

Router(config-telephony)# log table max-size 100

XML イベント テーブルのエントリの数を設定します。

number :エントリの数。値の範囲は 0 ~ 1000 です。デフォルトは 150 です。

ステップ 5

log table retain-timer minutes

 

Router(config-telephony)# log table retain-timer 30

イベント テーブルのエントリを削除するまでの保持期間を分単位で設定します。

minutes :分数。値の範囲は 2 ~ 500 です。デフォルトは 15 です。

ステップ 6

end

 

Router(config-telephony)# end

特権 EXEC モードに戻ります。

ステップ 7

show fb-its-log

 

Router# show fb-its-log

イベント ログを表示します。

ステップ 8

clear telephony-service xml-event-log

 

Router# clear telephony-service xml-event-log

XML イベント ログを消去します。

XML インターフェイスのトラブルシューティング


ステップ 1 debug cme-xml コマンドを使用して、Cisco Unified CME XML インターフェイスのデバッグ メッセージを表示します。


 

XML API の設定例

この項では、次の例について説明します。

「XML トランスポートのパラメータの例」

「XML アプリケーションのパラメータの例」

「XML 認証の例」

「XML イベント テーブルの例」

XML トランスポートのパラメータの例

次の例では、HTTP を XML トランスポート方式として選択します。

ip http server
ixi transport http
response size 8
request outstanding 2
request timeout 30
no shutdown

XML アプリケーションのパラメータの例

次の例では、アプリケーション応答タイムアウトを 30 秒に設定します。

ixi application cme
response timeout 30
no shutdown

XML 認証の例

次の例では、HTTP を XML トランスポート方式として選択します。user23 がパスワード 3Rs92uzQ を使用してアクセスすることを許可し、IP アドレス 192.168.146.72 からの要求を受け入れるアクセス リスト 99 を設定します。

ixi transport http
ip http server
!
telephony-service
xml user user23 password 3Rs92uzQ 15

XML イベント テーブルの例

次の例では、XML イベント テーブルの最大エントリ数を 100 に設定し、エントリの保持期間を 30 分に設定します。

telephony-service

log table max-size 100

log table retain-timer 30

関連情報

XML API に関する開発者向けの情報については、『 XML Provisioning Guide for Cisco CME/SRST 』を参照してください。

その他の資料

次の項では、Cisco Unified CME の機能に関連する参照資料を示します。

関連マニュアル

テクニカル サポート

説明
リンク

Cisco Support Web サイトでは、シスコ製品やシスコの技術に関するトラブルシューティングにお役立ていただけるように、マニュアルなどの豊富なオンライン リソースやツールを提供しています。Cisco Support Web サイトのほとんどのツールにアクセスするには、Cisco.com のユーザ ID とパスワードが必要です。サービス契約が有効で、ユーザ ID またはパスワードを取得していない場合は、Cisco.com で登録手続きを行ってください。

http://www.cisco.com/techsupport

XML API の機能情報

表71 は、この章で説明した機能、およびバージョンごとの機能拡張を示しています。

特定の Cisco Unified CME バージョンをサポートする正確な Cisco IOS リリースについては、「 Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix 」( http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm )を参照してください。

プラットフォームおよびソフトウェア イメージのサポートに関する情報を参照するには、Cisco Feature Navigator を使用します。Cisco Feature Navigator では、特定のソフトウェア リリース、機能セット、またはプラットフォームをサポートしている Cisco IOS ソフトウェアを確認できます。Cisco Feature Navigator にアクセスするには、 http://www.cisco.com/go/cfn に移動してください。Cisco.com のアカウントは必要ありません。


表71 は、所定の機能に対するサポートが導入された Cisco Unified CME のバージョンを示しています。特に断りのない限り、その機能は以降のバージョンの Cisco Unified CME ソフトウェアでもサポートされます。


 

表71 XML API の機能情報

機能名
Cisco Unified CME のバージョン
機能情報

日付および時刻に基づいたコール ブロッキング

4.0

XML API の仕様が変更され、Cisco IOS XML インフラストラクチャを通じて提供されるようになりました。すべての Cisco Unified CME 機能をサポートしています。 log password xmltest xmlschema 、および xmlthread の各コマンドは廃止されました。

3.0

XML API が導入されました。