- ホーム
- /
- 投稿記事
電話機 9800 および 8875 (BroadWorks) のプロファイル設定を構成する
このヘルプ記事は、Cisco BroadWorks に登録されている Cisco Desk Phone 9800 シリーズおよび Cisco Video Phone 8875 を対象としています。 このページの情報には、プロファイルの再同期、プロファイルの手動適用、および構成構文が含まれます。
プロファイルの再同期用に電話を設定する
電話機は、設定プロファイルを取得するための複数のネットワーク プロトコルをサポートします。 最も基本的なプロファイル転送プロトコルは、TFTP(RFC1350)です。 TFTP は、プライベート LAN ネットワーク内のネットワーク デバイスのプロビジョニングに広く使用されています。 TFTP は、インターネット経由のリモート エンドポイントの導入には推奨されませんが、小規模な組織内での導入、社内での事前プロビジョニング、および開発とテストで使用するには便利です。 次の手順では、TFTP サーバからファイルをダウンロードした後、プロファイルを変更します。
1 |
LAN 環境内で、コンピュータと電話をハブ、スイッチ、または小型ルーターに接続します。 |
2 |
コンピュータに、TFTP サーバーをインストールしてアクティブにします。 |
3 |
テキストエディタを使用して設定プロファイルを作成します。 プロファイルが後で電話にプロビジョニングされていないことを確認するには、いくつかの値をマークとして設定できます。 たとえば、次の例に示すように GPP_A の値を 12345678 に設定します。
|
4 |
TFTP サーバーのルートディレクトリに XML 設定ファイルを保存します。 TFTP サーバーが正しく設定されていることを確認できます。電話以外の TFTP クライアントを使用して設定プロファイルをリクエストします。 プロビジョニング サーバとは異なるホストで実行されている TFTP クライアントを使用することをお勧めします。 |
5 |
コンピュータの Web ブラウザーで、管理ウェブページを開きます。 たとえば、電話の IP アドレスが 192.168.1.100 であると仮定し、Web ブラウザーで次の URL を開きます。
|
6 |
タブを選択し、汎用目的パラメータ GPP_A ~ GPP_P の値を確認します。 これらは空でなければなりません。 |
7 |
Web ブラウザーで resync URL を開いて、テスト電話を作成した設定プロファイルと再同期します。 例: TFTP サーバの IP アドレスが 192.168.1.200 の場合、コマンドは次の例のようになります。
電話がこのコマンドを受け取ると、アドレス 192.168.1.100 のデバイスは、IP アドレス 192.168.1.200 にある TFTP サーバーに |
8 |
パラメータが正しく更新されていることを確認します。 管理ウェブページを更新し、 に移動します。これで、GPP_A パラメータに値 12345678 が含まれます。 |
1 |
製品ラベルから電話機の MAC アドレスを取得します (MAC アドレスは、000e08aabbcc など、数字と小文字の 16 進数を使用する数値です)。 |
2 |
設定ファイルの名前を 例:
|
3 |
TFTP サーバーの仮想ルートディレクトリに新しいファイルを移動します。 |
4 |
電話管理の Web ページにアクセスします。 |
5 |
を選択します。 |
6 |
[プロファイルルール(Profile Rule)] フィールドにプロファイルファイルのパスを入力します。 例:TFTP サーバー IP アドレスが 192.168.1.200 でプロファイルファイル名が以下のようなものだとします。
|
7 |
[すべての変更の送信(Submit All Changes)] をクリックします。 これにより、リブートと再同期がすぐに行われます。 次に再同期が実行されると、電話機は $MA マクロ式をその MAC アドレスに展開して新しいファイルを取得します。 |
1 |
ローカルコンピュータまたは他のアクセス可能なホストに HTTP サーバーをインストールします。 オープン ソースの Apache サーバをインターネットからダウンロードできます。 |
2 |
インストールされたサーバーの仮想ルートディレクトリに設定プロファイルファイルをアップロードします。 |
3 |
適切なサーバーのインストールとプロファイルファイルへのアクセスを確認するには、Web ブラウザーを使用してプロファイルを開きます。 |
4 |
プロファイルが定期的にダウンロードできるようにするために、テスト用電話機の Profile_Rule を変更して TFTP サーバの代わりに、HTTP サーバを指すようにします。 例えば、HTTP サーバーが 192.168.1.300 で、プロファイルのファイル名が basic.txt の場合、次の値を入力します。
|
5 |
[すべての変更の送信(Submit All Changes)] をクリックします。 これにより、リブートと再同期がすぐに行われます。 |
6 |
電話機から送信する syslog メッセージを確認します。 定期的な再同期で、HTTP サーバからプロファイルが取得されるようになります。 |
7 |
HTTP サーバのログで、テスト用電話機を識別する情報がユーザ エージェントのログにどのように表示されるのか確認します。 この情報には、製造者、製品名、現在のファームウェア バージョン、およびシリアル番号を含める必要があります。 |
デバイスは、(エンドポイントに明示的な再同期要求を送信するのではなく)定期的にプロビジョニング サーバと再同期することで、サーバ上で行われたすべてのプロファイル変更をエンドポイント デバイスに確実に伝達できます。
電話機をサーバと定期的に再同期させるためには、設定プロファイルの URL を Profile_Rule パラメータを使用して定義し、再同期期間を Resync_Periodic パラメータを使用して定義します。
1 |
電話管理の Web ページにアクセスします。 |
2 |
を選択します。 |
3 |
Profile_Rule パラメータを定義します。 この例では、TFTP サーバの IP アドレスを 192.168.1.200 とします。 |
4 |
[定期再同期(Resync Periodic)] フィールドに、30 秒など、テスト用の小さい値を入力します。 |
5 |
[すべての変更の送信(Submit All Changes)] をクリックします。 新しいパラメータ設定で、電話機は URL で指定された設定ファイルに対して 1 分間に 2 回再同期を行います。 |
6 |
Syslog トレースで結果のメッセージを確認します。 |
7 |
[リセット時の再同期(Resync On Reset)] フィールドが [はい(Yes)] に設定されます。
|
8 |
電源を再投入して、電話機をプロビジョニング サーバと強制的に再同期させます。 サーバが応答していないなど、何らかの理由で再同期操作が失敗する場合、ユニットは([再同期エラー再試行遅延(Resync Error Retry Delay)] で設定された秒数)待機した後、再同期を再試行します。 [再同期エラー再試行遅延(Resync Error Retry Delay)] が 0 の場合、電話機は再同期が失敗した後に再同期を試行しません。 |
9 |
(オプション)[再同期エラー再試行遅延(Resync Error Retry Delay)] フィールドの値を 30 などの小さい数に設定します。
|
10 |
TFTP サーバを無効にして、syslog 出力で結果を確認します。 |
次の表で、電話ウェブページの [設定プロファイル(Configuration Profile)] セクションにおける、プロファイル再同期パラメータの機能と使用方法を定義します。 また、パラメータを設定するために、XML コードを含む電話設定ファイルに追加される文字列のシンタックスも定義します。
タブの下にある
パラメータ |
説明 |
---|---|
[プロビジョン有効(Provision Enable)] |
再同期操作設定を許可または拒否します。
デフォルト:はい(Yes) |
[リセット時の再同期(Resync On Reset)] |
電源を入れた後やアップグレードを試行した後に、電話機がプロビジョニングサーバで設定を再同期するかどうかを指定します。
デフォルト:はい(Yes) |
[再同期ランダム遅延(Resync Random Delay)] |
多数のデバイスの電源が同時に投入され、初期設定が試行された場合のプロビジョニング サーバの過負荷状態を回避します。 この遅延は、デバイスの電源投入時またはリセット後の最初の設定試行時にのみ有効になります。 このパラメータは、プロビジョニングサーバに接続する前にデバイスが待機する最大時間間隔です。 実際の遅延は、0 ~ この値の範囲の擬似乱数です。 このパラメータの単位は 20 秒です。 有効値は 0 から 65535 の範囲です。
デフォルト値は 2 (40 秒) です。 |
[再同期時刻(HHmm)(Resync At (HHmm))] |
電話機をプロビジョニング サーバと再同期する時間(HHmm)。 このフィールドの値は、HHmm 形式で時刻を示すために 0000 から 2400 までの範囲の 4 桁の数字でなければなりません。 たとえば、0959 は 09:59 を示します。
デフォルト値は空です。 値が無効な場合、パラメータは無視されます。 このパラメータに有効な値が設定される場合、定期再同期(Resync Periodic)パラメータが無視されます。 |
[再同期時刻ランダム遅延(Resync At Random Delay)] |
多数のデバイスの電源が同時に起動するときの、プロビジョニング サーバの過負荷状態を回避できます。 複数の電話機からサーバへの再同期要求のフラッディングを回避するために、電話機は、時間と分の範囲と、時間と分およびランダム遅延(hhmm、hhmm+random_delay)を再同期します。 たとえば、ランダム遅延 = (ランダム遅延での再同期 + 30)/60 分である場合、秒単位の入力値が分に変換され、次の分に切り上げられて、最終的な random_delay 間隔が計算されます。
有効値は 600 から 65535 の範囲です。 値が 600 未満の場合、ランダム遅延内部は 0 ~ 600 です。 デフォルト値は 600 秒(10 分)です。 |
[定期再同期(Resync Periodic)] |
プロビジョニング サーバでの定期的な再同期の時間間隔。 サーバで同期が最初に成功した後にのみ関連付けられている再同期タイマーがアクティブになります。 有効なフォーマットは以下のとおりです。
定期再同期を無効にするには、このパラメータを 0 に設定します。 デフォルト値は 3600 秒です。 |
[再同期エラー再試行遅延(Resync Error Retry Delay)] |
電話機がサーバからプロファイルを取得できなかった、ダウンロードしたファイルが破損している、あるいは内部エラーが発生しているために再同期操作が失敗した場合、電話機はここで指定した時間(秒単位)が経過した後に再同期を再試行します。 有効なフォーマットは以下のとおりです。
遅延が 0 に設定されている場合、デバイスは再同期が失敗しても、再同期を再試行しません。
デフォルト:60,120,240,480,960,1920,3840,7680,15360,30720,61440,86400 |
[強制再同期遅延(Forced Resync Delay)] |
電話機が再同期を実行するまでの待機時間の最大遅延(秒単位)。 電話回線のいずれかがアクティブな間、デバイスは再同期しません。 再同期には数秒かかるため、デバイスが長時間アイドルになるまで待機してから再同期することをお勧めします。 これにより、ユーザは中断することなく通話できます。 デバイスには、すべての回線がアイドル状態になったときにカウント ダウンを開始するタイマーがあります。 このパラメータは、カウンタの初期値です。 再同期イベントは、このカウンタが 0 になるまで遅延します。 有効値は 0 から 65535 の範囲です。
デフォルト値は 14,400 秒です。 |
[SIPからの再同期(Resync From SIP)] |
サービス プロバイダーのプロキシ サーバから電話機に送信される SIP NOTIFY イベント経由の再同期操作に対するリクエストを制御します。 有効にされた場合は、プロキシが Event: resync ヘッダーを含む SIP NOTIFY メッセージをデバイスに送信することによって、再同期を要求できます。
デフォルト:はい(Yes) |
[アップグレード試行後の再同期(Resync After Upgrade Attempt)] |
アップグレードの実行後の再同期操作を有効または無効にします。 [はい(Yes)] を選択すると、ファームウェアアップグレード後に同期がトリガーされます。
デフォルト:はい(Yes) |
[再起動トリガー1(Resync Trigger 1)] [再起動トリガー2(Resync Trigger 2)] |
これらのパラメータの論理式が FALSE と評価した場合、[リセット時の再同期(Resync On Reset)] が TRUE に設定されていても再同期はトリガーされません。 直接アクション URL と SIP 通知による再同期のみが、これらの再同期トリガーを無視します。 このパラメータは、マクロ展開を行う条件式でプログラムできます。 有効なマクロ展開については、「プロビジョニング パラメータ」の マクロ展開変数 を参照してください。
デフォルト:空白 |
[ユーザ設定可能再同期(User Configurable Resync)] |
ユーザが電話画面メニューから電話機を再同期できるようにします。 [はい(Yes)] に設定すると、ユーザは電話機からプロファイルルールを入力して電話機の設定を再同期できます。 [いいえ(No)] に設定した場合、プロファイルルールパラメータは、電話機画面メニューに表示されません。
デフォルト:はい(Yes) |
[FNF時の再同期失敗(Resync Fails On FNF)] |
通常、再同期は、要求されたプロファイルがサーバから受信されなかった場合に失敗と見なされます。 このパラメーターは、この動作をオーバーライドします。 [いいえ(No)]に設定すると、デバイスはサーバからの
デフォルト:はい(Yes) |
[プロファイル認証タイプ(Profile Authentication Type)] |
プロファイル アカウントの認証に使用する認証情報を指定します。 次のオプションを使用できます。
デフォルト:基本的な HTTP 認証 詳細については、「 プロファイル認証タイプの指定 」( プロファイルの再同期用の電話の指定) を参照してください。 |
[プロファイルルール(Profile Rule)] [プロファイルルールB(Profile Rule B)] [プロファイルルールC(Profile Rule C)] [プロファイルルールD(Profile Rule D)] |
各プロファイル ルールは、プロファイル(設定ファイル)を取得するソースを電話機に通知します。 すべての再同期操作の間、電話機はすべてのプロファイルを順番に適用します。 構成ファイルに AES-256-CBC 暗号化を適用する場合は、次のように
オプションで暗号キーを二重引用符(")で囲むことができます。
デフォルト: |
[使用するDHCPオプション(DHCP Option To Use)] |
ファームウェアおよびプロファイルを取得するために使用される、コンマで区切られた DHCP オプション。 デフォルト:66,160,159,150,60,43,125 |
[使用するDHCPv6オプション(DHCPv6 Option To Use)] |
ファームウェアおよびプロファイルを取得するために使用される、コンマで区切られた DHCP オプション。 デフォルト:17,160,159 |
Cisco XML の機能を介して電話をプロビジョニングできます。
XML オブジェクトを SIP Notify パケットにより電話に送信するか、HTTP Post を使用して電話の CGI インターフェイス http://PhoneIPAddress/CGI/Execute
に送信できます。
CP-xxxx-3PCC では、Cisco XML 機能が拡張され、XML オブジェクトを介したプロビジョニングがサポートされます。
<CP-xxxx-3PCCExecute> <ExecuteItem URL=Resync:[profile-rule]/> </CP-xxxx-3PCCExecute>
電話機は XML オブジェクトを受け取ると、プロビジョニング ファイルを [profile-rule] からダウンロードします。 このルールでは、マクロを使用して XML サービス アプリケーションの開発を容易にできます。
複数のプロファイルがあるサーバ上のサブディレクトリは、導入された多数のデバイスを管理するのに便利です。 プロファイルの URL には、次を含めることができます。
-
プロビジョニング サーバ名または明示的な IP アドレス。 プロファイルで、プロビジョニング サーバが名前で識別される場合、電話機は DNS ルックアップを使用して名前を解決します。
-
サーバ名の後に標準シンタックス
:port
を使用して、URL で指定される非標準サーバ ポート。 -
標準 URL 表記を使用して指定され、マクロ展開で管理される、プロファイルが保存されているサーバ仮想ルート ディレクトリのサブディレクトリ。
たとえば、次の Profile_Rule は、ポート 6900 の接続をリスニングしているホスト prov.telco.com で実行中の TFTP サーバに対し、サーバ サブディレクトリ /cisco/config
内のプロファイル ファイル($PN.cfg)を要求します。
<Profile_Rule>
tftp://prov.telco.com:6900/cisco/config/$PN.cfg
</Profile_Rule>
各電話機のプロファイルは汎用パラメータで識別できます。その値は、マクロ展開を使用して共通のプロファイル ルール内で参照されます。
たとえば、GPP_B が Dj6Lmp23Q
として定義されているとします。
Profile_Rule は次の値になります。
tftp://prov.telco.com/cisco/$B/$MA.cfg
デバイスが再同期されて、マクロが展開されると、000e08012345 の MAC アドレスを持つ電話機は、次の URL にデバイスの MAC アドレスを含む名前を持つプロファイルを要求します。
tftp://prov.telco.com/cisco/Dj6Lmp23Q/000e08012345.cfg
プロファイル認証を使用すると、電話機ユーザはプロビジョニングプロファイルを電話機に再同期できます。 認証情報は、電話機が再同期と config ファイルのダウンロードを初めて試行しているときに HTTP または HTTPS 401 認証エラーが発生した場合に必要です。 この機能を有効にすると、以下の状況で [プロファイル アカウント セットアップ(Profile Account Setup)] 画面が電話機に表示されます。
-
電話機の再起動後のプロビジョニング中に HTTP または HTTPS 401 認証エラーが発生した場合
-
プロファイル アカウントのユーザ名とパスワードが空の場合
-
プロファイル ルールにユーザ名とパスワードがない場合
プロファイルアカウントの設定画面が見逃されたり無視されたりする場合は、電話スクリーンメニューからセットアップ画面にアクセスすることも、また電話機に回線が登録されていない場合にのみ表示される、セットアップソフトキーからアクセスすることもできます。
この機能を無効にすると、[プロファイル アカウント セットアップ(Profile Account Setup)] 画面は電話機に表示されません。
[プロファイル ルール(Profile Rule)] フィールドのユーザ名とパスワードには、プロファイル アカウントよりも高い優先順位があります。
-
ユーザ名とパスワードなしで正しい URL を [プロファイル ルール(Profile Rule)] フィールドに指定すると、 電話機はプロファイルを再同期するために認証またはダイジェストを要求します。 正しいプロファイル アカウントを使用すると、認証はパスします。 誤ったプロファイル アカウントでの認証は失敗します。
-
正しいユーザ名とパスワードで正しい URL を [プロファイル ルール(Profile Rule)] フィールドに指定すると、 電話機はプロファイルを再同期するために認証またはダイジェストを要求します。 プロファイル アカウントは電話機の再同期には使用されません。 サインインは成功します。
-
誤ったユーザ名とパスワードで正しい URL を [プロファイル ルール(Profile Rule)] フィールドに指定すると、 電話機はプロファイルを再同期するために認証またはダイジェストを要求します。 プロファイルアカウントは、電話の再同期には使用されません。 サインインは必ず失敗します。
-
誤った URL を [プロファイルルール(Profile Rule)] フィールドに指定すると、サインインは必ず失敗します。
XML(cfg.xml)コードを使用して電話機構成ファイルのパラメータを設定することもできます。
電話管理 Web ページからプロファイル認証タイプを指定できます。
1 |
電話管理の Web ページにアクセスします。 |
2 |
を選択します。 |
3 |
[設定プロファイル セクションで、プロファイルアカウント認証に使用する資格情報を指定するよう、プロファイル認証タイプパラメータを設定します。 次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。
オプション:
デフォルト:基本的な HTTP 認証 |
4 |
[すべての変更の送信(Submit All Changes)] をクリックします。 |
電話にプロファイルを手動で適用する
PC 上の TFTP サーバ アプリケーションに設定ファイルをダウンロードするには、次の手順を実行します。
1 |
コンピュータを電話の LAN ポートに接続します。 |
2 |
コンピュータ上の TFTP サーバーアプリケーションを実行し、設定ファイルが TFTP ルートディレクトリで利用可能であるか確認します。 |
3 |
Web ブラウザで、電話機の LAN IP アドレス、コンピュータの IP アドレス、ファイル名、ログイン クレデンシャルを入力します。 次の形式を使用します。
例:
|
cURL を使用して電話機に設定をダウンロードするには、次の手順を実行します。 このコマンドライン ツールを使用して、データを URL シンタックスで転送します。 cURL をダウンロードするには、次を参照してください。
https://curl.haxx.se/download.html
cURL の使用中にユーザー名とパスワードが取得される可能性があるため、設定を電話に転送する場合は cURL を使用しないことをお勧めします。
1 |
コンピュータを電話の LAN ポートに接続します。 |
2 |
次の cURL コマンドを入力して、電話機に設定ファイルをダウンロードします。
|
設定プロファイル
電話は XML フォーマットの設定を受け入れます。
このセクションの例では、XML シンタックスを使用した設定プロファイルを使用します。
設定プロファイルは、電話機のパラメータ値を定義します。
設定プロファイルの XML 形式では、標準の XML 作成ツールを使用してパラメータと値をコンパイルします。
電話機ごとに機能セットが異なるため、パラメータのセットも異なります。
例:オープンプロファイルフォーマット
オープン形式のプロファイルは、要素の階層に含まれる XML に似たシンタックスを使用するテキスト ファイルで、要素の属性と値が含まれます。 この形式では、標準のツールを使用して設定ファイルを作成できます。 XML 設定ファイルは、バイナリオブジェクトとしてコンパイルすることなく、再同期オペレーション中にプロビジョニングサーバーから電話に送信できます。
電話機は、標準ツールで生成された設定形式を受け入れることができます。 この機能により、既存のデータベースから設定プロファイルを生成するバックエンドのプロビジョニング サーバ ソフトウェアの開発が容易になります。
設定プロファイル内の機密情報を保護するために、プロビジョニングサーバーは XML 設定ファイルを TLS で保護されたチャネル経由で電話に送信します。 オプションで、gzip deflate アルゴリズムを(RFC1951)を使用して圧縮できます。
ファイルは、次のいずれかの暗号化方式で暗号化できます:
-
AES-256-CBC 暗号化
-
AES-128-GCM暗号化を使用したRFC-8188ベースのHTTPコンテンツ暗号化
設定ファイルには、次のコンポーネントを含めることができます。
-
要素タグ
-
Attributes
-
パラメータ
-
フォーマット機能
-
XML コメント
例: オープンプロフィール形式
<flat-profile><Resync_On_Reset> Yes </Resync_On_Reset><Resync_Periodic> 7200 </Resync_Periodic><Profile_Rule> tftp://prov.telco.com:6900/cisco/config/CP_xxxx_MPP.cfg</Profile_Rule></flat-profile>
<flat-profile>
要素タグで、電話で認識されるすべてのパラメータ要素を囲みます。
要素タグのプロパティ
設定ファイルを作成または更新するときには、次のルールに注意してください。
-
XML プロビジョニング形式と Web UI の構成を、同じ設定にすることができます。 XML タグ名と Web UI 内のフィールド名は似ていますが、XML 要素名の制限によって異なります。 たとえば、XML 設定ファイルでは、Web UI 上のスペースの代わりにアンダースコア(_)を使用します。
-
電話は、特殊な
<flat-profile>
要素でカプセル化された適切なパラメータ名の要素を認識します。 -
要素名は山カッコで囲まれます。
-
ほとんどの要素名は電話の Web UI のフィールド名に似ています。変更は次のとおりです。
-
要素名にはスペースまたは特殊文字を含めることはできません。 Web フィールド名から要素名を派生するには、すべてのスペースまたは特殊文字
[
、]
、(
、)
、または/
をアンダースコアに置き換えます。例:<Resync_On_Reset> 要素は [リセット時に再同期(Resync On Reset)] フィールドを表します。
-
各要素名は固有の名前でなければなりません。 電話 Web UI では、同じフィールドが、[回線(Line)]、[ユーザー(User)]、および [内線(Extension)] ページなど、複数のウェブページに表示される場合があります。
[N]
を要素名に追加して、ページ タブに表示される番号を示します。例:
<Dial_Plan_1_>
要素は回線 1 の [ダイヤルプラン(Dial Plan)] を表します。
-
-
各開始要素タグには、対応する終了要素タグが必要です。 次に例を示します。
<flat-profile> <Resync_On_Reset> Yes </Resync_On_Reset> <Resync_Periodic> 7200 </Resync_Periodic> <Profile_Rule>tftp://prov.telco.com: 6900/cisco/config/CP_xxxx_MPP.cfg </Profile_Rule> </flat-profile>
-
要素タグは、大文字と小文字が区別されます。
-
空の要素タグは許可され、値が空になるよう設定されているものと解釈されます。 対応する終了要素タグのない開始要素タグを入力し、閉じ山カッコ(>)の前にスペースとスラッシュを挿入します。 この例では、プロファイル ルール B が空です。
<Profile_Rule_B />
-
空の要素タグは、同期操作中にユーザが指定した値の上書きを防ぐために使用できます。 以下の例では、ユーザの短縮ダイヤル設定は変更されません。
<flat-profile> <Speed_Dial_2_Name ua="rw"/> <Speed_Dial_2_Number ua="rw"/> <Speed_Dial_3_Name ua="rw"/> <Speed_Dial_3_Number ua="rw"/> <Speed_Dial_4_Name ua="rw"/> <Speed_Dial_4_Number ua="rw"/> <Speed_Dial_5_Name ua="rw"/> <Speed_Dial_5_Number ua="rw"/> <Speed_Dial_6_Name ua="rw"/> <Speed_Dial_6_Number ua="rw"/> <Speed_Dial_7_Name ua="rw"/> <Speed_Dial_7_Number ua="rw"/> <Speed_Dial_8_Name ua="rw"/> <Speed_Dial_8_Number ua="rw"/> <Speed_Dial_9_Name ua="rw"/> <Speed_Dial_9_Number ua="rw"/> </flat-profile>
-
空の値を使用して対応するパラメータを空の文字列に設定します。 開始要素と終了要素の間に値を含めずに入力します。 次の例では、GPP_A パラメータが空の文字列に設定されます。
<flat-profile> <GPP_A> </GPP_A> </flat-profile>
-
認識されない要素名は無視されます。
パラメータのプロパティ
次のプロパティがパラメータに適用されます。
プロファイルで指定されないパラメータは、電話機で変更されません。
認識されないパラメータは無視されます。
オープン形式プロファイルに同じパラメータ タグが複数回含まれている場合、最後のタグが前のタグを上書きします。 パラメータの設定値の不注意な上書きを避けるために、プロファイルごとに 1 つのパラメータのインスタンスを 1 回だけ指定することをお勧めします。
最後に処理されたプロファイルが優先されます。 複数のプロファイルで同じ設定パラメータが指定される場合、後のプロファイルの値が優先されます。
文字列のフォーマット
以下のプロパティは、文字列の形式に適用されます。
コメントは標準の XML シンタックスを通じて許可されます。
<!-- My comment is typed here -->
先頭および末尾の空白文字は読みやすくするために許可されていますが、パラメータ値からは削除されます。
値内の改行はスペースに変換されます。
<? ?>
形式の XML ヘッダーは使用できますが、電話機では無視されます。特殊文字を入力するには、次の表に示すように基本的な XML エスケープ文字を使用します。
特殊文字
XML エスケープ シーケンス
&(アンパサンド)
&
<(より小さい)
<
>(より大きい)
>
’(アポストロフィ)
'
"(二重引用符)
"
次の例では、エスケープ文字は、ダイヤル プラン ルールに必要なより大きい記号とより小さい記号を表すために入力されています。 この例では、<Dial_Plan_1_> パラメータ(
)を(S0 <:18005551212>)と同じに設定する情報ホットラインダイヤルプランを定義しています。<flat-profile> <Dial_Plan_1_> (S0 <:18005551212>) </Dial_Plan_1_></flat-profile>
10 進数値および 16 進数値を使用した、数字エスケープ(s.a.
(
および.
)が変換されます。電話ファームウェアは、ASCII 文字のみサポートします。
オープン設定プロファイルを圧縮してプロビジョニング サーバのネットワーク負荷を軽減できます。 プロファイルを暗号化して機密情報を保護することもできます。 圧縮は必須ではありませんが、暗号化よりも前に実行する必要があります。
オープンプロファイルの圧縮
サポートされている圧縮方法は、gzip 圧縮アルゴリズム(RFC1951)です。 gzip ユーティリティと、同じアルゴリズム(zlib)を実装する圧縮ライブラリをインターネット サイトから入手できます。
圧縮を識別するために、電話機には gzip 互換ヘッダーを含む圧縮ファイルが必要です。 元のオープン プロファイルで gzip ユーティリティを呼び出すと、ヘッダーが生成されます。 電話機はダウンロードされたファイル ヘッダーを検査し、ファイル形式を判断します。
たとえば、profile.xml
が有効なプロファイルである場合、ファイル profile.xml.gz
も受け入れられます。 このプロファイルは、次のいずれかのコマンドで生成できます。
-
>gzip profile.xml
元のファイルを圧縮ファイルで置き換えます。
-
>cat profile.xml | gzip > profile.xml.gz
元のファイルは残して、新しい圧縮ファイルを生成します。
オープンプロファイルの暗号化
ファイルを圧縮するかどうかに関わらず、オープン設定プロファイルを対称キー暗号化を使用して暗号化できます。 圧縮を適用する場合は、暗号化の前に適用する必要があります。
プロビジョニング サーバは、HTTPS を使用して、電話機導入後の最初のプロビジョニングを処理します。 設定プロファイルをオフラインで事前に暗号化すると、後でプロファイルを再同期するために HTTP を使用できます。 これより、大規模な導入で HTTPS サーバの負荷が軽減します。
電話機は、設定ファイルに対して2つの暗号化方式に対応しています。
-
AES-256-CBC 暗号化
-
AES-128-GCM暗号化を使用したRFC 8188ベースのHTTPコンテンツ暗号化
キーは、ユニットに先に事前プロビジョニングする必要があります。 秘密キーのブートストラップは、HTTPS を使用して安全に実行できます。
設定ファイル名は特定のフォーマットを必要としませんが、拡張子 .cfg
で終わるファイル名は通常構成プロファイルを示します。
AES-256-CBC 暗号化
電話機は、設定ファイル用の AES-256-CBC 暗号化をサポートしています。
さまざまなインター ネット サイトからダウンロードできる OpenSSL 暗号化ツールで暗号化を実行できます。 256 ビットの AES 暗号化をサポートするために、ツールを再コンパイルして AES コードを有効化することが必要な場合があります。 ファームウェアはバージョン openssl-1.1.1d に対してテストされています。
暗号化されたファイルの場合、プロファイルには、次のコマンドで生成されたものと同じ形式のファイルが必要です。
# example encryption key = SecretPhrase1234 openssl enc –e –aes-256-cbc –k SecretPhrase1234 –in profile.xml –out profile.cfg # analogous invocation for a compressed xml file openssl enc –e –aes-256-cbc –k SecretPhrase1234 –in profile.xml.gz –out profile.cfg
小文字 -k を秘密キーの前に置きます。秘密キーは任意のプレーン テキスト文字列で、ランダムな 64 ビット salt の生成に使用されます。 -k 引数で指定された秘密キーを使用して、暗号化ツールは、ランダムな 128 ビットの初期ベクトルと実際の 256 ビットの暗号キーを生成します。
この形式の暗号化を設定プロファイルで使用する場合、ファイルを復号するために電話機に秘密キーの値を通知する必要があります。 この値は、プロファイル URL の修飾子として指定されます。 シンタックスは明示的な URL を使用し、次のようになります。
[--key “SecretPhrase1234”] http://prov.telco.com/path/profile.cfg
この値は、Profile_Rule
パラメータのいずれかを使用してプログラムされます。
マクロ展開
いくつかのプロビジョニング パラメータは、評価される前に内部でマクロ展開によって処理されます。 この評価前の手順によって、電話機の再同期とアップグレードのアクティビティをより柔軟に制御できます。
次のパラメータ グループは、評価前にマクロ展開によって処理されます。
-
Resync_Trigger_*
-
Profile_Rule*
-
Log_xxx_Msg
-
Upgrade_Rule
特定の条件下では、一部の汎用パラメータ (GPP_*) もマクロ展開の対象になります。これについては、以下の オプションの再同期引数 セクションで明示的に示しています。
マクロ展開時に、名前付き変数の内容は $NAME および $(NAME) 形式の式を置き換えます。 これらの変数には、汎用パラメータ、いくつかの製品識別子、特定のイベント タイマー、およびプロビジョニング状態の値が含まれます。 完全なリストについては、「 プロビジョニング パラメータ 」の マクロ拡張変数を参照してください。
次の例では、式 $(MAU) を使用して MAC アドレス 000E08012345 を挿入します。
管理者は次を入力します。$(MAU)config.cfg
MAC アドレス 000E08012345 のデバイスのマクロ展開の結果は次のようになります。000E08012345config.cfg
マクロ名が認識されない場合、展開されません。 たとえば、名前 STRANGE は有効なマクロ名として認識されませんが、MAU は有効なマクロ名として認識されます。
管理者は次を入力します。$STRANGE$MAU.cfg
MAC アドレス 000E08012345 のデバイスのマクロ展開の結果は次のようになります。$STRANGE000E08012345.cfg
マクロ展開は再帰的に適用されません。 たとえば、$$MAU” は $MAU” に展開し($$ が展開される)、MAC アドレスにはなりません。
特殊な目的のパラメータ(GPP_SA ~ GPP_SD)の内容は、マクロ式 $SA ~ $SD にマッピングされます。 これらパラメータのみ、resync URL の --key、--uid、および --pwd オプションの引数としてマクロ展開されます。
条件式
条件式によって、再同期イベントをトリガーし、再同期およびアップグレード操作の代替 URL から選択できます。
条件式は、and 演算子で区切られた比較の一覧で構成されています。 条件が true になるためにはすべての比較が満たされる必要があります。
各比較は、次の 3 種類のリテラルのいずれかに関連付けることができます。
-
整数の値
-
ソフトウェアまたはハードウェアのバージョン番号
-
二重引用符で囲まれた文字列
バージョン番号
Cisco Video Phone 8875 のソフトウェアのバージョンはこのフォーマットを使用します(BN は ビルド番号)。
PHONEOSyyyy.1-0-1-0001-BN
yyyy は、電話のモデルまたは電話シリーズを示します。1 はメジャーバージョンです。0 はマイナーバージョンです。1-0001 はマイクロバージョンを示し、BN はビルド番号です。
比較文字列は、同じ形式を使用する必要があります。 異なる形式を使用すると、形式解析エラーが発生します。
ソフトウェア バージョンを比較する場合、メジャーバージョン、マイナーバージョン、マイクロバージョンは順番に比較され、左端の数字が後に続く数字よりも優先されます。 バージョン番号が同一の場合は、ビルド番号が比較されます。
有効なバージョン番号の例
PHONEOS-8875.1-0-1-0001-19
比較
引用符で囲まれた文字列は、等しいかどうか比較できます。 整数とバージョン番号は算術的に比較することもできます。 比較演算子は記号または略語で表すことができます。 略語はオープン形式のプロファイルで条件を表す場合に便利です。
演算子 |
代替シンタックス |
説明 |
整数およびバージョンのオペランドに適用可能 |
引用符で囲まれた文字列のオペランドに適用可能 |
---|---|---|---|---|
= |
eq |
等しい |
対応 |
対応 |
!= |
ne |
等しくない |
対応 |
対応 |
< |
lt |
より少ない |
対応 |
未対応 |
<= |
le |
以下 |
対応 |
未対応 |
> |
gt |
より大きい |
対応 |
未対応 |
>= |
ge |
以上 |
対応 |
未対応 |
および |
|
および |
対応 |
対応 |
リテラル文字列が必要な場合はマクロ変数を二重引用符で囲むことが重要です。 数字またはバージョン番号が必要な場合は二重引用符で囲まないでください。
Profile_Rule* および Upgrade_Rule パラメータのコンテキストで使用する場合は、このアップグレード ルールの例のようにシンタックス「(expr)?」内に条件式を含める必要があります。 BN をアップグレードするファームウェアロードのビルド番号に置き換えることを忘れないでください。
($SWVER ne PHONEOS-8875.1-0-1-0001-19)? http://ps.tell.com/sw/PHONEOS-8875.1-0-1-0001-BN.loads
Resync_Trigger_* パラメータを設定するために、前述のシンタックスをかっこを付けて使用しないでください。
URL 構文
標準の URL シンタックスを使用して、設定ファイルとファームウェアのロードを Profile_Rule* および Upgrade_Rule パラメータにそれぞれに取得する方法を指定します。 構文は次のとおりです。
[ scheme:// ] [ server [:port]] filepath
scheme
は次のいずれかの値になります。
-
tftp
-
http
-
https
scheme
を省略すると、tftp が使用されます。 server には DNS で認識されるホスト名または数値の IP アドレスを使用できます。 port は宛先の UDP または TCP ポート番号です。 filepath はルート ディレクトリ(/)で始まり、絶対パスであることが必要です。
server
を指定しない場合、DHCP(オプション 66)で指定される TFTP サーバが使用されます。
アップグレード ルールでは、サーバを指定する必要があります。
port
を指定しない場合、指定されたスキームの標準ポートが使用されます Tftp は UDP ポート 69、http は TCP ポート 80、https は TCP ポート 443 をそれぞれ使用します。
filepath は存在する必要があります。 静的なファイルを参照する必要はありませんが、CGI を通じて取得されるダイナミック コンテンツを指定できます。
マクロ展開は、URL 内に適用されます。 次は有効な URL の例です。
/$MA.cfg /cisco/cfg.xml 192.168.1.130/profiles/init.cfg tftp://prov.call.com/cpe/cisco$MA.cfg http://neptune.speak.net:8080/prov/$D/$E.cfg https://secure.me.com/profile?Linksys
DHCP オプション 66 を使用する場合、空のシンタックスはアップグレード ルールでサポートされません。 プロファイルルール*にのみ適用されます。
RFC 8188ベースのHTTPコンテンツ暗号化
電話機は、設定ファイル用の AES-128-GCM 暗号化を使用する RFC 8188 ベースの HTTP コンテンツ暗号化に対応しています。 この暗号化方法では、どのエンティティも HTTP メッセージヘッダーを読み取ることができます。 ただし、IKM(Input Keying Material)を認識しているエンティティのみがペイロードを読み取ることができます。 電話機に IKM がプロビジョニングされている場合、電話機とプロビジョニングサーバは構成ファイルを安全に交換でき、サードパーティのネットワーク要素は分析および監視の目的でメッセージヘッダーを使用できます。
XML 構成パラメーター IKM_HTTP_Encrypt_Content
IKM を電話機で保持します。 セキュリティ上の理由から、電話管理 Web ページでこのパラメータにアクセスすることはできません。 電話機の IP アドレスから、またはプロビジョニングサーバに送信された電話機の設定レポートからアクセスできる電話機の設定ファイルにも表示されません。
RFC 8188 ベースの暗号化を使用する場合は、次の点を確認してください:
-
プロビジョニングサーバから電話機に送信される設定ファイルでXMLパラメータ
IKM_HTTP_Encrypt_Content
を使用してIKMを指定し、IKMを使用して電話機をプロビジョニングします。 -
プロビジョニングサーバーから電話に送信される設定ファイルにこの暗号化が適用されている場合は、設定ファイルの Content-Encoding HTTP ヘッダーに
aes128gcm があることを確認してください。
.このヘッダーがない場合、AES-256-CBC メソッドが優先されます。 AES-256-CBCキーがプロファイルルールに存在する場合、電話機はIKMに関係なくAES-256-CBC復号化を適用します。
-
プロビジョニングサーバに送信する設定レポートにこの暗号化を適用する場合は、レポートルールに AES-256-CBC キーが指定されていないことを確認します。
オプションの再同期引数
Profile_Rule*
パラメータに入力した URL の前にオプションの引数 key
、uid
、および pwd
を角かっこで囲んでまとめて指定できます。
キー
--key
オプションは、ファイル内の Content-Encoding ヘッダーが aes128gcm
暗号化を示さない限り、プロビジョニングサーバーから受信する設定ファイルが AES-256-CBC 暗号化で暗号化されていることを電話に伝えます。 キー自体は--key
という用語の後に続く文字列として指定されます。 オプションで暗号キーを二重引用符(")で囲むことができます。 電話機は、キーを使用して設定ファイルを復号化します。
使用例
[--key VerySecretValue][--key “my secret phrase”][--key a37d2fb9055c1d04883a0745eb0917a4]
カッコで囲まれたオプションの引数はマクロ展開されています。 特殊な目的のパラメータ(GPP_SA ~ GPP_SD)は、key オプションの引数として使用される場合のみ、マクロ変数 $SA ~$SD にマクロ展開されます。 次の例を参照してください。
[--key $SC] [--key “$SD”]
オープン形式のプロファイルでは、--key に対する引数は、openssl に与えられた -k オプションに対する引数と同じであることが必要です。
uid と pwd
Uidおよびpwdオプションは、指定した URL が要求されたときに HTTP ベーシックおよびダイジェスト認証のチャレンジに対する応答として送信されるユーザIDとパスワードを指定するために使用される場合があります。 カッコで囲まれたオプションの引数はマクロ展開されています。 特殊な目的のパラメータ(GPP_SA ~ GPP_SD)は、key オプションの引数として使用される場合のみ、マクロ変数 $SA ~$SD にマクロ展開されます。 次の例を参照してください。
GPP_SA = MyUserID GPP_SB = MySecretPassword
[--uid $SA --pwd $SB] https://provisioning_server_url/path_to_your_config/your_config.xml
これは次のように展開されます。
[--uid MyUserID --pwdMySecretPassword] https://provisioning_server_url/path_to_your_config/your_config.xml
以下のデータ型は、設定プロファイルのパラメータで使用されます。
-
{a,b,c,…}:a、b、c… からの選択肢。
-
Bool:「yes」または「no」のブール値。
-
CadScript:信号のパターン パラメータを指定するミニスクリプト。 最大 127 文字。
シンタックス:S1[;S2]。次の意味があります。
-
Si=Di(oni,1/offi,1[,oni,2/offi,2[,oni,3/offi,3[,oni,4/offi,4[,oni,5/offi,5[,oni,6/offi,6]]]]]) で、これはセクションとして知られています。
-
oni,j および offi,j は segment の秒単位の on/off 継続時間です。i = 1 または 2、および j = 1 ~ 6 です。
-
Di は、セクションの合計継続時間(秒単位)です。
すべての継続時間には、1 ミリ秒単位の精度を実現するため、小数点以下第 3 位まで含めることができます。 ワイルドカード文字 “*” は無期限を意味します。 セクション内のセグメントは順番に実行され、合計時間が実行されるまで繰り返されます。
例 1:
60(2/4) Number of Cadence Sections = 1 Cadence Section 1: Section Length = 60 s Number of Segments = 1 Segment 1: On=2s, Off=4s Total Ring Length = 60s
例 2:特殊呼び出し音(短、短、短、長)
60(.2/.2,.2/.2,.2/.2,1/4) Number of Cadence Sections = 1 Cadence Section 1: Section Length = 60s Number of Segments = 4 Segment 1: On=0.2s, Off=0.2s Segment 2: On=0.2s, Off=0.2s Segment 3: On=0.2s, Off=0.2s Segment 4: On=1.0s, Off=4.0s Total Ring Length = 60s
-
-
DialPlanScript:回線 1 と回線 2 のダイヤル プランを指定するために使用するスクリプト シンタックス。
-
Float<n>:小数点以下第 n 位までを含む浮動小数点値。
-
FQDN:完全修飾ドメイン名。最大 63 文字を指定できます。 例は次のとおりです。
sip.Cisco.com:5060 または 109.12.14.12:12345
sip.Cisco.com または 109.12.14.12
-
FreqScript:トーンの周波数とレベル パラメータを指定するミニスクリプト。 最大 127 文字です。
シンタックス:F1@L1[,F2@L2[,F3@L3[,F4@L4[,F5@L5[,F6@L6]]]]]。次の意味があります。
-
F1 ~ F6 は Hz 単位の周波数(符号なし整数のみ)です。
-
L1 ~ L6 は、dBm 単位の対応レベル(小数点以下第 1 位までを含む)です。
コンマの前後に空白は使用できますが、推奨されません。
例 1:コール ウェイティング トーン
440@-10 Number of Frequencies = 1 Frequency 1 = 440 Hz at –10 dBm
例 2:ダイヤル トーン
350@-19,440@-19 Number of Frequencies = 2 Frequency 1 = 350 Hz at –19 dBm Frequency 2 = 440 Hz at –19 dBm
-
-
IP: x.x.x.x 形式の有効な IPv4 アドレス。x は 0 ~ 255 です。例:10.1.2.100。
-
UserID:URL に表示されるユーザー ID。最大 63 文字です。
-
電話:14081234567、*69、*72、345678 などの電話番号文字列。または 1234@10.10.10.100:5068 や jsmith@Cisco.com などの一般的な URL。 文字列には最大 39 文字を含めることができます。
-
PhTmplt:電話番号テンプレート。 各テンプレートには、コンマ(,)で区切られた 1 つ以上のパターンを含めることができます。 各パターンの先頭の空白は無視されます。 「?」と「*」はワイルドカード文字を表します。 文字どおり表すには、%xx を使用します。 たとえば、%2a は * を表します。 テンプレートには最大 39 文字を含めることができます。 例:“1408*、1510*”、“1408123????, 555?1.”。
-
Port:TCP/UDP ポート番号(0 ~ 65535)。 これは 10 進数または 16 進数形式で指定できます。
-
ProvisioningRuleSyntax:設定の再同期とファームウェア アップグレード ルールを定義するために使用するスクリプト シンタックス。
-
PwrLevel:–小数点以下第 1 位を含む、dBm 単位で表されるパワー レベル。13.5 や 1.5(dBm)など。
-
RscTmplt:SIP 応答ステータス コードのテンプレート。“404, 5*”、“61?”、“407、408、487、481”。 加入者 ID には最大 39 文字を指定できます。
-
Sig<n>:署名付き n ビット値。 これは 10 進数または 16 進数形式で指定できます。 「-」符号を負の値の前に付ける必要があります。 正の値の前の「+」符号はオプションです。
-
Star Codes:* 69 などの補足サービス用アクティベーション コード。 コードには最大 7 文字を含めることができます。
-
Str<n>:最大 n 文字の非予約文字。
-
Time<n>:小数点以下第 n 位までを含む秒単位の継続時間。 追加で指定した小数点以下の桁は無視されます。
-
ToneScript:コールプログレストーンの周波数、レベル、パターン パラメータを指定するミニスクリプト。 スクリプトには最大 127 文字を指定できます。
シンタックス:FreqScript;Z1[;Z2]。
セクション Z1 は CadScript の S1 セクションと似ていますが、各 on/off セグメントの後に周波数コンポーネント パラメータが続く点が異なります。Z1 = D1(oni,1/offi,1/fi,1[,oni,2/offi,2/fi,2 [,oni,3/offi,3/fi,3 [,oni,4/offi,4/fi,4 [,oni,5/offi,5/fi,5 [,oni,6/offi,6/fi,6]]]]])。次の意味があります。
-
fi,j = n1[+n2]+n3[+n4[+n5[+n6]]]]]。
-
1 < nk < 6 は、そのセグメントで使用される FreqScript 内の周波数コンポーネントを指定します。
1 つのセグメントで複数の周波数コンポーネントが使用されている場合、コンポーネントは合計されます。
例 1:ダイヤル トーン:
350@-19,440@-19;10(*/0/1+2) Number of Frequencies = 2 Frequency 1 = 350 Hz at –19 dBm Frequency 2 = 440 Hz at –19 dBm Number of Cadence Sections = 1 Cadence Section 1: Section Length = 10 s Number of Segments = 1 Segment 1: On=forever, with Frequencies 1 and 2 Total Tone Length = 10s
例 2:断絶トーン:
350@-19,440@-19;2(.1/.1/1+2);10(*/0/1+2) Number of Frequencies = 2 Frequency 1 = 350 Hz at –19 dBm Frequency 2 = 440 Hz at –19 dBm Number of Cadence Sections = 2 Cadence Section 1: Section Length = 2s Number of Segments = 1 Segment 1: On=0.1s, Off=0.1s with Frequencies 1 and 2 Cadence Section 2: Section Length = 10s Number of Segments = 1 Segment 1: On=forever, with Frequencies 1 and 2 Total Tone Length = 12s
-
-
Uns<n>:符号なし n ビット値。n は 8、16、または 32 です。値は、n ビットにフィットする限り、12 または 0x18 のように 10 進数または 16 進数フォーマットで指定できます。
次の点に注意してください。
- <Par Name> は設定パラメータ名を表します。プロファイルでは、Par_Name のように、スペースをアンダースコア「_」に置き換えることで、対応するタグが形成されます。
- 空のデフォルト値フィールドは空の文字列 < “” > を意味します。
- 電話機は特定のプロファイルに存在しないタグに最後に設定された値を引き続き使用します。
- テンプレートは、所定の順序で比較されます。 最初の最も近くない一致が選択されます。 パラメータ名は完全に一致する必要があります。
- プロファイルで 1 つのパラメータに複数の定義が指定されている場合、ファイル内の該当する最後の定義が電話機で有効な定義になります。
- パラメータに空のパラメータ値を指定すると、パラメータは強制的にそのデフォルト値に戻ります。 代わりに空の文字列を指定するには、空文字列 "" をパラメータ値として使用します。