Cisco Unified Communications Manager アドミニストレーション ガイド リリース 10.0(1)
SIP 正規化スクリプトの設定
SIP 正規化スクリプトの設定

SIP 正規化スクリプトの設定

この章では、Cisco Unified Communications Manager の SIP 正規化スクリプトの設定に関する情報を提供します。

SIP 正規化スクリプトの設定の概要

Cisco Unified Communications Manager の管理ページで、[デバイス(Device)] > [デバイスの設定(Device Settings)] > [SIP正規化スクリプト(SIP Normalization Script)] メニュー パスを使用して、SIP 正規化および透過スクリプトを設定します。

SIP トランクは、PBX、ゲートウェイ、サービス プロバイダーなど、さまざまなエンドポイントに接続できます。 各エンドポイントの SIP トランクの実装は若干異なるため、固有の相互運用性の問題が発生します。 トランクごとにメッセージを正規化するために、Cisco Unified Communications Manager ではシステムにスクリプトを追加または更新し、1 つまたは複数の SIP トランクに関連付けることができます。 作成する正規化スクリプトによって、既知または不明な SIP ヘッダーまたはコンテンツ本体の内容を保持、削除、または変更できます。

透過とは、1 つのコール レッグから別のコール レッグに情報を渡す機能のことです。 REFER 透過により、Cisco Unified Communications Manager では、REFER 要求を処理する代わりに別のエンドポイントに要求を渡すことができます。 REFER 透過は、コールのいずれの側からも地理的に離れた場所でエージェントが REFER(転送の開始)を送信することになる、コール センター アプリケーションの場合に重要です。

Cisco Unified Communications Manager でスクリプトを設定した後、[トランクの設定(Trunk Configuration)] ウィンドウの [正規化スクリプト(Normalization Script)] フィールドを設定して、スクリプトを SIP トランクに関連付けます。 トランクごとに関連付けできるスクリプトは 1 つだけですが、同じスクリプトを複数のトランクに関連付けできます。

SIP 正規化スクリプトの設定のヒント

refer-passthrough スクリプトは編集できません。 refer-passthrough スクリプトの内容をカスタム スクリプトで使用するには、[SIP正規化スクリプト(SIP Normalization Script)] ウィンドウにスクリプトを表示します。 [内容(Content)] フィールドから情報をコピーし、[新規追加(Add New)] ボタンをクリックして新規スクリプト レコードを作成してから、refer-passthrough スクリプトからコピーした情報を新規レコードに貼り付けます。

SIP 正規化スクリプトの削除

refer-passthrough スクリプトは削除できません。

SIP 正規化スクリプトの設定値

次の表に、SIP 正規化スクリプトの設定値を示します。

表 1 SIP 正規化スクリプトの設定値

フィールド

説明

[名前(Name)]

スクリプトの固有の識別子を入力します。 この名前には、最長 50 文字の英数字を指定することができ、スペース、ピリオド(.)、ハイフン(-)、およびアンダースコア(_)を任意に組み合わせて使用することが可能です。

[説明(Description)]

スクリプトの記述名を入力します。

[内容(Content)]

このフィールドには、インポートされるスクリプトの内容が表示されます。 このテキストボックスでスクリプトを編集できます。

[スクリプト実行エラーの復旧処理(Script Execution Error Recovery Action)]

スクリプト メッセージ ハンドラの実行中に実行エラーが検出された場合に実行する処理を選択します。

実行エラーは、スクリプトが Cisco SIP メッセージ API の 1 つを起動したが、間違った数の引数を渡した場合や、スクリプトが nil 文字列を文字列ライブラリ API に渡した場合など、さまざまな問題によって発生する可能性があります。

実行エラーが検出されると、メッセージ ハンドラは障害ポイントで自動的に終了され、メッセージはメッセージ ハンドラ実行前の元の内容に復元され(つまり、メッセージのロールバックが実行され)、システムはメッセージ ハンドラが実行されなかったように続行されます。

自動エラー メッセージ処理の後、ドロップダウン リスト ボックスで選択した次の処理が実行されます。

  • [SIPメッセージのロールバックのみ(SIP Message Rollback Only)]:(デフォルト)後続のメッセージに対してスクリプトの実行が続行されます。
  • [SIPスクリプトの無効化(SIP Disable Script)]:スクリプトは Cisco Unified Communications Manager によって終了され、後続のメッセージに対して実行されません。 Lua 状態は終了のままであり、すべてのメモリが再要求されます。 トランクを手動でリセットして、スクリプトを再度有効にする必要があります。
  • [SIPスクリプトのリセット(SIP Reset Script)]:スクリプトは Cisco Unified Communications Manager によって終了され、即座にリロードされます。 スクリプトが終了されると、Lua 状態は終了され、すべてのメモリが再要求されます。 スクリプトによって維持されるすべての状態は失われます。 スクリプトのリロード後、スクリプトは Cisco Unified Communications Manager によって後続のメッセージに対して自動的に使用されます。
  • [SIPスクリプトのトランクのリセット(SIP Script Reset Trunk)]:トランクは即座にリセットされ、これにより既存のコールが影響を受けます。 スクリプトのリセット中に、スクリプトは Cisco Unified Communications Manager によって終了されます。 トランクの再起動後、スクリプトは Cisco Unified Communications Manager によって自動的に再度開かれます。

[システムリソースエラーの復旧処理(System Resource Error Recovery Action)]

[メモリしきい値(Memory Threshold)] および [Lua命令しきい値(Lua Instruction Threshold)] の値を超えたために実行中にスクリプトが中止されたときに、Cisco Unified Communications Manager で実行する処理を選択します。

リソース エラーは、スクリプトによるメッセージ ハンドラのロード、初期化、または実行中に発生する可能性があります。 ロードまたは初期化が失敗すると、スクリプトは即座に無効になります。

設定した [システムリソースエラーの復旧処理(System Resource Error Recovery Action)] は、ロード エラーまたは初期化エラーには適用されません。 この処理は実行エラーだけに適用されます。 実行エラーはメッセージ ハンドラの実行中だけに発生します。

スクリプトによるメッセージ ハンドラの実行中にリソース エラーが発生すると、メッセージ ハンドラは障害ポイントで自動的に終了され、メッセージはメッセージ ハンドラ実行前の元の内容に復元され(つまり、メッセージのロールバックが実行され)、システムはメッセージ ハンドラが実行されなかったように続行されます。

自動エラー メッセージ処理の後、ドロップダウン リスト ボックスで選択した次の処理が実行されます。

  • [SIPスクリプトの無効化(SIP Disable Script)]:(デフォルト)スクリプトは終了され、後続のメッセージに対して実行されません。 Lua 状態は終了のままであり、すべてのメモリが再要求されます。 トランクを手動でリセットして、スクリプトを再度有効にする必要があります。
  • [SIPスクリプトのリセット(SIP Reset Script)]:スクリプトは終了され、即座にリロードされます。 スクリプトが終了されると、Lua 状態は終了され、すべてのメモリが再要求されます。 スクリプトによって維持されるすべての状態は失われます。 スクリプトのリロード後、スクリプトは Cisco Unified Communications Manager によって後続のメッセージに対して自動的に使用されます。
  • [SIPスクリプトのトランクのリセット(SIP Script Reset Trunk)]:トランクは即座にリセットされ、これにより既存のコールが影響を受けます。 トランクのリセット中に、スクリプトは終了されます。 トランクの再起動後、スクリプトは自動的に再度開かれます。

[メモリしきい値(Memory Threshold)]

メモリしきい値を KB 単位で入力します。 このフィールドには整数を入力する必要があります。

メモリ使用率がこの値の 80 % を超えると、SIPNormalizationScriptResourceWarning リソース警告アラームが生成されます。 メモリ使用率がこの値の 100 % を超えるまで、スクリプトの実行は続行されます。

スクリプトのロードまたは初期化中にメモリ使用率が 100 % を超えた場合、スクリプト エラー アラームが生成され、スクリプトは終了および無効化されます。

スクリプトの実行中にメモリ使用率が 100 % を超えた場合、スクリプト エラー アラームが生成され、[システムリソースエラーの復旧処理(System Resource Error Recovery Action)] フィールドで指定した処理が Cisco Unified Communications Manager によって実行されます。

たとえば、このフィールドに 50 KB と入力した場合、スクリプトが 40 KB を超えると警告アラームが生成されます。 メモリ使用が 50 KB を超えるまで、スクリプトの実行は続行されます。

デフォルト値は 50 KB です。

[Lua命令しきい値(Lua Instruction Threshold)]

このフィールドでは、特定のメッセージ ハンドラで起動できる Lua 命令の最大数を指定します。 スクリプトがこの値の 50 % を超えると、リソース警告アラームが生成されます。 スクリプトがこの値の 100 % を超えるまで、スクリプトの実行は続行されます。

スクリプトのロードまたは初期化中にスクリプトが [Lua命令しきい値(Lua Instruction Threshold)] の値の 100 % を超えた場合、SIPNormalizationScriptResourceWarning リソース警告アラームが生成され、スクリプトは Cisco Unified Communications Manager によって終了および無効化されます。

スクリプトの実行中にスクリプトが [Lua命令しきい値(Lua Instruction Threshold)] の値の 100 % を超えた場合、SIPNormalizationScriptResourceWarning アラームが生成され、[システムリソースエラーの復旧処理(System Resource Error Recovery Action)] フィールドで指定した処理が Cisco Unified Communications Manager によって実行されます。

たとえば、このフィールドに 1000 と入力した場合、スクリプトが 500 命令を超えると警告アラームが生成されます。 1000 命令を超えるまで、スクリプトの実行は続行されます。

デフォルト値は、メッセージ ハンドラの起動ごとに 1000 命令です。

[リセット(Reset)]

このスクリプトが関連付けられている内部トランク デバイスをシャットダウンしてから再起動するには、このボタンをクリックします。

[ファイルのインポート(Import File)]

スクリプトをインポートするには、このボタンをクリックします。

開かれる [ファイルのインポート(Import File)] ポップアップ ウィンドウで、[ファイルのインポート(Import File)] フィールドの右側にある [参照(Browse)] ボタンをクリックして、ファイルを検索します。 [ファイルのアップロード(File Upload)] ポップアップ ウィンドウを使用して、アップロードするファイルに移動します。 ファイルを検索したら、目的のファイル名をクリックし、[開く(Open)] をクリックします。 選択したスクリプト ファイルへのパスが、[ファイルのインポート(Import File)] ポップアップ ウィンドウの [ファイルのインポート(Import File)] フィールドに表示されます。 指定したスクリプト ファイルをアップロードするには、[ファイルのインポート(Import File)] をクリックします。 何も実行しないで [ファイルのインポート(Import File)] ポップアップ ウィンドウを閉じるには、[閉じる(Close)] をクリックします。

スクリプト ファイルのアップロード後、[ファイルのインポート(Import File)] ウィンドウの [ステータス(Status)] 領域にアップロードの結果が表示されます。 スクリプト ファイルの内容が [内容(Content)] フィールドに表示されます。

SIP 正規化スクリプトのインポート

SIP 正規化スクリプトを Cisco Unified Communications Manager へインポートするには、以下の手順を実行します。

手順
    ステップ 1   [デバイス(Device)] > [デバイスの設定(Device Settings)] > [SIP正規化スクリプト(SIP Normalization Script)] を選択します。

    [SIP正規化スクリプトの検索/一覧表示(Find and List SIP Normalization Scripts)] ウィンドウが表示されます。

    ステップ 2   次のいずれかの作業を行います。
    1. 新しいスクリプト インスタンスを追加する場合は、[新規追加(Add New)] ボタンをクリックします。 [SIP正規化スクリプト設定(SIP Normalization Script Configuration)] ウィンドウが表示されます。
    2. 既存のスクリプト インスタンスを更新する場合は、該当するスクリプト インスタンスを検索し、更新するスクリプトの名前をクリックします。
    ステップ 3   スクリプトをインポートするには、[ファイルのインポート(Import File)] ボタンをクリックします。

    [ファイルのインポート(Import File)] ダイアログボックスが表示されます。

    ステップ 4   [参照(Browse)] ボタンをクリックしてインポートするファイルを検索し、[開く(Open)] ボタンをクリックします。
    ステップ 5   [ファイルのインポート(Import File)] ボタンをクリックします。

    スクリプト ファイルの内容が [内容(Content)] フィールドに表示されます。

    ステップ 6   ウィンドウで必要なフィールドを修正します。
    ステップ 7   [保存(Save)] をクリックし、[リセット(Reset)] をクリックします。