- ホーム
- /
- 投稿記事
電話のプロファイル設定を構成する
このヘルプ記事は、Cisco BroadWorks に登録されている Cisco 電話用です。このページの情報には、プロファイルの再同期、プロファイルの手動適用、設定構文が含まれます。
プロファイルの再同期用に電話機を設定する
電話機は、設定プロファイルを取得するための複数のネットワーク プロトコルをサポートしています。最も基本的なプロファイル転送プロトコルは TFTP(RFC1350)です。TFTP は、プライベート LAN ネットワーク内のネットワーク デバイスのプロビジョニングに広く使用されています。インターネット経由のリモートエンドポイントの展開には推奨されませんが、TFTP は、小規模組織内の展開、社内の事前プロビジョニング、開発とテストに便利です。次の手順では、TFTP サーバからファイルをダウンロードした後、プロファイルが変更されます。
1 |
LAN 環境内で、コンピュータと電話機をハブ、スイッチ、または小さなルータに接続します。 |
2 |
コンピュータ上で、TFTP サーバをインストールしてアクティブ化します。 |
3 |
テキスト エディタを使用して、設定プロファイルを作成します。 プロファイルが後で電話機にプロビジョニングされたかどうかを確認するには、いくつかの値をマークとして設定できます。たとえば、次の例に示すように、GPP_A の値を 12345678 に設定します。
_ |
4 |
XML 設定ファイルを TFTP サーバのルート ディレクトリに保存します。 TFTP サーバが正しく設定されていることを確認できます。電話機以外の TFTP クライアントを使用して、設定プロファイル ファイルを要求します。プロビジョニング サーバとは別のホストで実行されている TFTP クライアントを使用することをお勧めします。 |
5 |
コンピュータの Web ブラウザで管理 Web ページを開きます。たとえば、電話機の IP アドレスが 192.168.1.100 であると仮定して、次の URL をウェブブラウザで開きます。
|
6 |
タブを選択し、汎用パラメータ GPP_A ~ GPP_P の値を調べます。これらは空である必要があります。 |
7 |
Web ブラウザで再同期 URL を開いて作成した設定プロファイルに、テスト電話機を再同期します。 例: TFTP サーバの IP アドレスが 192.168.1.200 の場合、コマンドは次の例に似ている必要があります。
電話機がこのコマンドを受信すると、アドレス 192.168.1.100 のデバイスは、IP アドレス 192.168.1.200 の TFTP サーバから設定プロファイル ファイル |
8 |
パラメータが正しく更新されたことを確認します。管理 Web ページを更新し、 に移動します。GPP_A パラメータに値 12345678 が含まれている必要があります。 |
1 |
製品ラベルから電話機の MAC アドレスを取得します。(MAC アドレスは、000e08aabbcc など、数字と小文字の 16 進数を使用する番号です。 |
2 |
設定ファイルの名前を 例: |
3 |
新しいファイルを TFTP サーバの仮想ルート ディレクトリに移動します。 |
4 |
電話機の管理 Web ページにアクセスします。 |
5 |
を選択します。 |
6 |
[プロファイル ルール] フィールドにプロファイル ファイルのパスを入力します。 例: TFTP サーバの IP アドレスが 192.168.1.200 で、プロファイル ファイル名は rofile_ |
7 |
[すべての変更を提出] をクリックします。これにより、即時再起動と再同期が発生します。 次の再同期が発生すると、電話機は $MA マクロ式をその MAC アドレスに拡張することによって、新しいファイルを取得します。 |
1 |
ローカルコンピュータまたは他のアクセス可能なホストに HTTP サーバをインストールします。 オープンソースの Apache サーバはインターネットからダウンロードできます。 |
2 |
設定プロファイル ファイルをインストールしたサーバの仮想ルート ディレクトリにアップロードします。 |
3 |
適切なサーバのインストールを確認し、プロファイル ファイルにアクセスするには、Web ブラウザでプロファイルを開きます。 |
4 |
プロファイルを定期的にダウンロードするために、テスト電話機の Profile_ルールを変更して、TFTP サーバの代わりに HTTP サーバを指します。 たとえば、HTTP サーバが 192.168.1.300 で、プロファイルのファイル名が basic.txt であると仮定して、次の値を入力します。 rofile_ |
5 |
[すべての変更を提出] をクリックします。これにより、即時再起動と再同期が発生します。 |
6 |
電話機が送信する syslog メッセージを確認します。定期的な再同期では、HTTP サーバからプロファイルを取得する必要があります。 |
7 |
HTTP サーバ ログで、テスト 電話機を識別する情報がユーザ エージェントのログにどのように表示されるかを確認します。 この情報には、製造元、製品名、現在のファームウェア バージョン、およびシリアル番号が含まれます。 |
デバイスはプロビジョニング サーバに定期的に再同期して、サーバ上で行われたプロファイルの変更がエンドポイント デバイスに反映されるようにできます(エンドポイントに明示的な再同期要求を送信するのではなく)。
電話機をサーバに定期的に再同期させるには、設定プロファイル URL は Profile_Rule パラメータを使用して定義され、再同期期間は Resync_Periodic パラメータを使用して定義されます。
1 |
電話機の管理 Web ページにアクセスします。 |
2 |
を選択します。 |
3 |
Profile_Rule パラメータを定義します。この例では、TFTP サーバの IP アドレス 192.168.1.200 を想定しています。 |
4 |
[定期的な再同期] フィールドで、テスト用の小さい値を入力します。たとえば、30 秒です。 |
5 |
[すべての変更を提出] をクリックします。 新しいパラメータ設定では、電話機は URL で指定した設定ファイルに 1 分間に 2 回再同期します。 |
6 |
syslog トレースで表示されるメッセージを確認します。 |
7 |
[リセット時に再同期] フィールドが [はい] に設定されていることを確認します。 esync_ |
8 |
電話機の電源を再投入して、プロビジョニング サーバに再同期するように強制します。 サーバーが応答しないなど、何らかの理由で再同期操作が失敗した場合、ユニットは (再同期エラー再試行遅延で設定された秒数) 待機してから、再同期を再試行します。[再同期エラー再試行遅延] がゼロの場合、電話機は再同期試行に失敗した後に再同期を試みません。 |
9 |
(オプション) [再同期エラー再試行遅延] フィールドの値を 30 などの小数値に設定します。 esync_ |
10 |
TFTP サーバを無効にし、syslog 出力で結果を確認します。 |
次の表は、電話機のウェブページの [音声] > セクションにおける、プロファイル再同期パラメータの機能と使用方法を定義しています。また、パラメータを設定するために、XML コードを使用して電話機設定ファイル(cfg.xml)に追加される文字列のシンタックスを定義します。
パラメータ |
説明 |
---|---|
プロビジョニングの有効化 |
設定プロファイルの再同期アクションを許可または拒否します。
デフォルト:はい |
リセット時に再同期 |
電源投入後、および各アップグレード試行後に電話機がプロビジョニング サーバと設定を再同期するかどうかを指定します。
デフォルト:はい |
再同期ランダム遅延 |
多数のデバイスが同時に電源をオンにし、初期設定を試みた場合、プロビジョニング サーバの過負荷を防止します。この遅延は、デバイスの電源をオンまたはリセットした後、初期設定試行でのみ有効になります。 このパラメータは、デバイスがプロビジョニング サーバと通信するまで待機する最大時間間隔です。実際の遅延は、0 からこの値の間の擬似乱数です。 このパラメータは 20 秒単位です。 有効な値は 0 ~ 65535 です。
デフォルト値は 2(40 秒)です。 |
再同期 (HHmm) |
電話機がプロビジョニング サーバと再同期する時間(HHmm)。 HHmm 形式で時刻を示すには、このフィールドの値は 0000 ~ 2400 の 4 桁の数字である必要があります。たとえば、0959 は 09:59 を示します。
デフォルト値は空です。値が無効な場合、パラメータは無視されます。このパラメータに有効な値が設定されている場合、[定期再同期(Resync Periodic)] パラメータは無視されます。 |
ランダム遅延時の再同期 |
多数のデバイスの電源が同時にオンになっている場合、プロビジョニング サーバの過負荷を防ぎます。 複数の電話機からのサーバへの再同期要求のフラッディングを回避するために、電話機は時間と分、時間と分とランダム遅延 (hhmm、hhmm+random_delay) の範囲で再同期します。たとえば、ランダム遅延 = (ランダム遅延で再同期 + 30)/60 分の場合、秒単位の入力値は分に変換され、次の分に切り上げて最終的なrandom_delay 間隔を計算します。
有効な値は 600 ~ 65535 です。 値が 600 未満の場合、ランダム遅延内部は 0 ~ 600 です。 デフォルト値は 600 秒(10 分)です。 |
定期的な再同期 |
プロビジョニング サーバとの定期的な再同期間の時間間隔。関連する再同期タイマーは、サーバとの最初の同期が成功した後にのみアクティブになります。 有効な形式は次のとおりです。
定期的な再同期を無効にするには、このパラメータを 0 に設定します。 デフォルト値は 3600 秒です。 |
再同期エラーの再試行遅延 |
電話機がサーバからプロファイルを取得できない、ダウンロードしたファイルが破損している、または内部エラーが発生したために再同期操作が失敗した場合、電話機は秒単位で指定された時間後に再同期を再試行します。 有効な形式は次のとおりです。
遅延が 0 に設定されている場合、デバイスは再同期試行に失敗した後に再同期を再試行しません。
デフォルト:60,120,240,480,960,1920,3840,7680,15360,30720,61440,86400 |
強制再同期遅延 |
電話機が再同期を実行するまで待機する最大遅延(秒単位)。 電話回線の 1 つがアクティブになっている間は、デバイスは再同期されません。再同期には数秒かかる場合があるため、再同期する前にデバイスがアイドル状態になるまで長期間待つことが望ましいです。これにより、ユーザは中断することなく連続してコールを発信できます。 デバイスには、すべての回線がアイドル状態になると、カウントダウンを開始するタイマーがあります。このパラメータは、カウンタの初期値です。再同期イベントは、このカウンタが 0 になるまで遅延します。 有効な値は 0 ~ 65535 です。
デフォルト値は 14,400 秒です。 |
SIP から再同期 |
サービス プロバイダー プロキシ サーバから電話機に送信される SIP NOTIFY イベントを介した再同期操作の要求を制御します。有効にすると、プロキシはイベントを含む SIP NOTIFY メッセージを送信することで、再同期を要求できます。デバイスに再同期ヘッダー。
デフォルト:はい |
アップグレード試行後の再同期 |
アップグレードが行われた後の再同期操作を有効または無効にします。[はい] を選択した場合、ファームウェア アップグレード後に同期がトリガーされます。
デフォルト:はい |
再同期トリガー 1 再同期トリガー 2 |
これらのパラメータの論理式が FALSE と評価された場合、[リセット時に再同期] が [TRUE] に設定されている場合でも、再同期はトリガーされません。ダイレクト アクション URL と SIP 通知による再同期のみが、これらの再同期トリガーを無視します。 パラメータは、マクロ展開を実行する条件式を使用してプログラムできます。有効なマクロ展開については、「プロビジョニング パラメータ 」の下の「マクロ展開変数」を参照してください。
デフォルト:空白 |
ユーザー設定可能な再同期 |
ユーザは、電話画面メニューから電話機を再同期できます。[はい] に設定すると、ユーザーは電話機からプロファイル ルールを入力することで電話機の設定を再同期できます。[いいえ] に設定すると、[プロファイル ルール] パラメータが電話画面メニューに表示されません。
デフォルト:はい |
FNF で再同期が失敗する |
通常、再同期は、要求されたプロファイルがサーバから受信されない場合、失敗と見なされます。このパラメータは、この動作を上書きします。[いいえ] に設定すると、デバイスはサーバーからの
デフォルト:はい |
プロファイル認証タイプ |
プロファイル アカウントの認証に使用するクレデンシャルを指定します。使用可能なオプションは次のとおりです。
デフォルト:基本的な HTTP 認証 詳細については、「プロファイル再同期用の電話の指定 」の「プロファイル認証タイプの指定」を参照してください。 |
プロファイル ルール プロファイル ルール B プロファイル ルール C プロファイル ルール D |
各プロファイル ルールは、プロファイル(設定ファイル)を取得するソースを電話機に通知します。再同期操作のたびに、電話機はすべてのプロファイルを順番に適用します。 設定ファイルに AES-256-CBC 暗号化を適用する場合は、次のように暗号キーを 必要に応じて、暗号キーを二重引用符(")で囲むことができます。
デフォルト: |
使用する DHCP オプション |
ファームウェアとプロファイルを取得するために使用される、コンマで区切られた DHCP オプション。 デフォルト:66,160,159,150,60,43,125 |
使用する DHCPv6 オプション |
ファームウェアとプロファイルを取得するために使用される、コンマで区切られた DHCP オプション。 デフォルト:17,160,159 |
Cisco XML 機能を使用して電話機をプロビジョニングできます。
SIP Notify パケットまたは HTTP Post を使用して、電話機の CGI インターフェイスに XML オブジェクトを送信できます。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 Rule>
rofile_ 各電話機のプロファイルは、汎用パラメータで識別できます。その値は、マクロ展開を使用して共通のプロファイル ルール内で参照されます。
たとえば、GPP_B が Dj6Lmp23Q
として定義されているとします。
Profile_ルールには次の値があります。
tftp://prov.telco.com/cisco/$B/$MA.cfg
デバイスの再同期とマクロが展開されると、000e08012345 の MAC アドレスを持つ電話機は、次の URL でデバイス MAC アドレスを含む名前を持つプロファイルを要求します。
tftp://prov.telco.com/cisco/Dj6Lmp23Q/000e08012345.cfg
プロファイル認証により、電話ユーザはプロビジョニング プロファイルを電話機に再同期できます。認証情報は、電話機が初めて設定ファイルを再同期してダウンロードしようとし、HTTP または HTTPS 401 認証エラーが発生する場合に必要です。この機能を有効にすると、次の状況で、[プロファイル アカウントのセットアップ] 画面が電話機に表示されます。
-
電話機の再起動後の初回プロビジョニング中に HTTP または HTTP 401 認証エラーが発生した場合
-
プロファイルアカウントのユーザー名とパスワードが空の場合
-
プロファイルルールにユーザー名とパスワードがない場合
[プロファイル アカウントのセットアップ] 画面が見つからないか無視されている場合、ユーザーは電話画面メニューからセットアップ画面にアクセスできます。[セットアップ] ソフトキーは、電話機に回線が登録されていない場合にのみ表示されます。
この機能を無効にすると、[プロファイル アカウントのセットアップ] 画面が電話機に表示されません。
[プロファイルルール ] フィールドのユーザー名とパスワードは、プロファイルアカウントよりも高い優先度を持ちます。
-
ユーザー名とパスワードなしで正しい URL を [プロファイル ルール] フィールドに指定すると、電話機はプロファイルを再同期するために認証またはダイジェストを要求します。正しいプロファイル アカウントでは、認証がパスされます。プロファイル アカウントが正しくない場合、認証は失敗します。
-
[プロファイル ルール] フィールドに正しいユーザー名とパスワードで正しい URL を指定した場合、電話機はプロファイルを再同期するために認証またはダイジェストを要求します。プロファイル アカウントは、電話の再同期には使用されません。サインインに成功しました。
-
[プロファイル ルール] フィールドに正しい URL を誤ったユーザー名とパスワードで指定した場合、電話機はプロファイルを再同期するために認証またはダイジェストを要求します。プロファイル アカウントは電話の再同期に使用されません。サインインは常に失敗します。
-
[プロファイル ルール] フィールドに間違った URL を入力すると、サインインは常に失敗します。
XML(cfg.xml)コードを使用して電話機の設定ファイルのパラメータを設定することもできます。
電話機の管理 Web ページからプロファイル認証タイプを指定できます。
1 |
電話機の管理 Web ページにアクセスします。 |
2 |
[音声 > プロビジョニング] の順に選択します。 |
3 |
[設定プロファイル ] セクションで、[プロファイル認証タイプ ] パラメータを設定し、プロファイル アカウント認証に使用する資格情報を指定します。 次の形式で文字列を入力することで、電話機設定の XML ファイル(cfg.xml)でこのパラメータを設定できます。 rofile_ オプション:
デフォルト:基本的な HTTP 認証 |
4 |
[すべての変更を提出] をクリックします。 |
電話機にプロファイルを手動で適用する
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 設定ファイルは、バイナリ オブジェクトとしてコンパイルすることなく、再同期操作中にプロビジョニング サーバから電話機に送信できます。
電話機は、標準ツールが生成する設定形式を受け入れることができます。この機能により、既存のデータベースから構成プロファイルを生成するバックエンド プロビジョニング サーバ ソフトウェアの開発が容易になります。
設定プロファイルの機密情報を保護するために、プロビジョニング サーバは TLS で保護されたチャネルを介して XML 設定ファイルを電話機に送信します。オプションで、gzip deflate アルゴリズム(RFC )を使用してファイルを圧縮することができます。
ファイルは、次のいずれかの暗号化方式で暗号化できます。
-
AES-256-CBC 暗号化
-
AES-128-GCM 暗号化による RFC-8188 ベースの HTTP コンテンツ暗号化
設定ファイルには、次のコンポーネントを含めることができます。
-
要素タグ
-
属性
-
パラメータ
-
フォーマット機能
-
XML コメント
例:プロファイル形式を開く
<flat-profile> <Resync_On_Reset> はい On_Reset> <Resync_定期的> 7200 定期的> <Profile_Rule> tftp://prov.telco.com:6900/cisco/config/CP_xxxx_MPP.cfgRule> </flat-profile>
esync_esync_rofile_ 要素タグは、電話機が認識するパラメータ要素をすべて囲みます。
要素タグのプロパティ
設定ファイルを作成または更新する場合は、次のルールに留意してください。
-
XML プロビジョニング形式と Web UI では、同じ設定を構成できます。Web UI の XML タグ名とフィールド名は類似していますが、XML 要素名の制限によって異なります。たとえば、Web UI のスペースの代わりに、XML 構成ファイルのアンダースコア (_ )。
-
電話機は、特別な
要素にカプセル化された適切なパラメータ名を持つ要素を認識します。
-
要素名は角括弧で囲まれています。
-
ほとんどの要素名は、電話機の Web UI のフィールド名に似ており、次の変更があります。
-
要素名にスペースまたは特殊文字を含めることはできません。ウェブフィールド名から要素名を派生するには、すべてのスペースまたは特殊文字
[
、]
、(
、)
、または/
のアンダースコアを置き換えます。例: <Resync_On_Reset> 要素は [リセット時に再同期] フィールドを表します。
-
各要素名は一意である必要があります。電話機の Web UI では、[回線(Line)]、[ユーザ(User)]、[内線番号(Extension)] ページなど、複数の Web ページに同じフィールドを表示できます。要素名に
[n]
を追加して、ページ タブに表示される番号を指定します。例:
<Dial_Plan_1_>
要素は、回線 1 のダイヤル プラン を表します。
-
-
各開始要素タグには一致する終了要素タグが必要です。たとえば、次のようなものです。
rofile_<Resync_On_Reset> はい On_Reset> <Resync_Periodic> 7200 Periodic> <Profile_Rule>tftp://prov.telco.com:esync_esync_ 6900/cisco/config/CP_xxxx_MPP.cfg Rule>
-
要素タグは大文字と小文字を区別します。
-
空の要素タグは許可され、値を空に設定すると解釈されます。対応する要素タグなしで開始要素タグを入力し、閉じ角カッコ(>)の前にスペースとスラッシュを挿入します。この例では、プロファイル ルール B が空です。
<Profile_Rule_B />
-
空の要素タグを使用して、再同期操作中にユーザが指定した値を上書きするのを防ぐことができます。次の例では、ユーザの短縮ダイヤル設定は変更されません。
<flat-profile> <Speed_dial_2_名前 ua="rw"/> <Speed_dial_2_番号 ua="rw"/> <Speed_dial_3_名前 ua="rw"/> <Speed_dial_3_番号 ua="rw"/> <Speed_dial_4_名前 ua="rw"/> <Speed_dial_4_番号 ua="rw"/> <Speed_dial_5_名前 ua="rw"/> <Speed_dial_5_番号 ua="rw"/> <Speed_dial_6_名前 ua="rw"/> <Speed_dial_6_番号 ua="rw"/> <Speed_dial_7_名前 ua="rw"/> <Speed_dial_7_番号 ua="rw"/> <Speed_dial_8_名前 ua="rw"/> <Speed_dial_8_番号 ua="rw"/> <Speed_dial_9_名前 ua="rw"/> <Speed_dial_9_番号 ua="rw"/> </flat-profile>
-
空の値を使用して、対応するパラメータを空の文字列に設定します。開始要素と終了要素の間には値がありません。次の例では、GPP_A パラメータが空の文字列に設定されています。
_<flat-profile> <GPP_A> A> </flat-profile>
-
認識されない要素名は無視されます。
パラメータのプロパティ
これらのプロパティは、パラメータに適用されます。
プロファイルで指定されていないパラメータは、電話機で変更されません。
認識されないパラメータは無視されます。
オープン形式プロファイルに、同じパラメータ タグの複数のオカレンスが含まれている場合、最後のオカレンスが以前のオカレンスを上書きします。パラメータの設定値の不注意なオーバーライドを回避するために、各プロファイルでパラメータのインスタンスを 1 つ以上指定することをお勧めします。
最後に処理されたプロファイルが優先されます。複数のプロファイルで同じ設定パラメータが指定されている場合、後者のプロファイルの値が優先されます。
文字列の形式
これらのプロパティは、文字列の書式設定に適用されます。
コメントは標準の XML 構文を通じて許可されます。
先頭および末尾の空白は読みやすくできますが、パラメータ値から削除されます。
値内の新しい行はスペースに変換されます。
<? ?>
形式の XML ヘッダーは許可されていますが、電話機では無視されます。特殊文字を入力するには、次の表に示すように、基本 XML 文字のエスケープを使用します。
特殊文字
XML エスケープ シーケンス
& (アンパサンド)
&
< (より小さい)
<
> (より大きい)
>
」(アポストロフ)
'
(二重引用符)
"
次の例では、ダイヤル プラン ルールで必須の記号よりも大きい記号と小さい記号を表すエスケープ文字が入力されています。この例では、<Dial_Plan_1_> パラメータ (
) を (S0 ) に設定する情報ホットライン ダイヤル プランを定義しています。
ial_<flat-profile> <Dial_Plan_1_> (S0 ) Plan_1_> </flat-profile>
10 進数と 16 進数の値を使用した数字エスケープ (例:
(
および.
) は翻訳されます。電話機のファームウェアは、ASCII 文字のみをサポートします。
オープン コンフィギュレーション プロファイルを圧縮して、プロビジョニング サーバのネットワーク負荷を軽減できます。プロファイルを暗号化して、機密情報を保護することもできます。圧縮は必須ではありませんが、暗号化の前にする必要があります。
オープンプロファイルの圧縮
サポートされている圧縮方法は、gzip デフレートアルゴリズム(RFC )です。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 コンテンツ暗号化
キーまたは入力キー材料 (IKM) は、以前にユニットに事前プロビジョニングする必要があります。秘密キーのブートストラップは、HTTPS を使用して安全に実行できます。
設定ファイル名は特定の形式を必要としませんが、拡張子 .cfg
で終わるファイル名は通常、設定プロファイルを示します。
AES-256-CBC 暗号化
電話機は、設定ファイルの AES-256-CBC 暗号化をサポートします。
さまざまなインターネットサイトからダウンロードできるOpenSSL暗号化ツールは、暗号化を実行できます。256 ビットの AES 暗号化をサポートするには、ツールを再コンパイルして AES コードを有効にする必要があります。ファームウェアはバージョン openssl-1.1.1d に対してテストされています。
暗号化されたファイルの場合、プロファイルは、次のコマンドによって生成されたファイルと同じ形式であることを期待します。
# 暗号化キーの例 = SecretPhrase1234 openssl enc –e –aes-256-cbc –k SecretPhrase1234 –in profile.xml –out profile.cfg # 圧縮された xml ファイルの類似した呼び出し 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
パラメータのいずれかを使用してプログラムされます。
マクロ展開
いくつかのプロビジョニング パラメータは、評価される前に内部でマクロ展開されます。この事前評価手順により、電話機の再同期とアップグレードのアクティビティをより柔軟に制御できます。
これらのパラメータ グループは、評価前にマクロ展開が行われます。
-
esync_rigger_*
-
Profile_ルール*
-
Log_xxx_Msg
-
Upgrade_ ルール
特定の条件下では、いくつかの汎用パラメータ (GPP_*) もマクロ展開を受けます。下の [オプションの再同期引数] セクションに明示的に示されています。
マクロ展開時に、名前付き変数の内容が $NAME および $(NAME) 形式の式を置き換えます。これらの変数には、汎用パラメータ、複数の製品識別子、特定のイベント タイマー、プロビジョニング状態値が含まれます。完全なリストについては、プロビジョニング パラメータ の下の マクロ拡張変数を参照してください。
次の例では、式 $(MAU) を使用して、MAC アドレス 000E08012345 を挿入します。
管理者が $(MAU)config.cfg
と入力します。
MAC アドレス 000E08012345 を持つデバイスのマクロ展開の結果は次のとおりです。000E08012345config.cfg
マクロ名が認識されない場合は、展開されません。たとえば、名前 STRANGE は有効なマクロ名として認識されず、MAU は有効なマクロ名として認識されます。
管理者が入力します: $STRANGE$MAU.cfg
MAC アドレス 000E08012345 を持つデバイスのマクロ展開の結果は次のとおりです。$STRANGE 000E08012345.cfg
マクロ展開は再帰的に適用されません。たとえば、$$MAU” は $MAU” に展開され ($$ が展開されます)、MAC アドレスにはなりません。
特殊目的パラメータ GPP_SA ~ GPP_SD の内容は、マクロ式 $SA ~ $SD にマッピングされます。これらのパラメータは、再同期 URL の --key 、--uid、および --pwd オプションの引数としてのみマクロ展開されます。
条件式
条件式は、再同期イベントをトリガーし、再同期とアップグレード操作の代替 URL から選択できます。
条件式は、比較のリストで構成され、と 演算子で区切られています。条件が真であるためには、すべての比較が満たされている必要があります。
各比較は、次の 3 種類のリテラルに関連付けることができます。
-
整数
-
ソフトウェアまたはハードウェアのバージョン番号
-
二重引用符
バージョン番号
Cisco Video Phone 8875 のソフトウェア バージョンでは、次の形式 (BN はビルド番号です) を使用します。
電話機yyyy.1-0-1-0001-BN
yyyy は電話機のモデルまたは電話シリーズを示します。1 はメジャーバージョン、0 はマイナーバージョン、1-0001 はマイクロ バージョン、BN はビルド番号です。
比較文字列は同じ形式を使用する必要があります。それ以外の場合は、形式解析エラーが生成されます。
ソフトウェア バージョンを比較する場合、メジャー バージョン、マイナー バージョン、マイクロバージョンが順番に比較され、左端の数字が後者の数字よりも優先されます。バージョン番号が同一の場合、ビルド番号が比較されます。
有効なバージョン番号の例
電話-8875.1-0-1-0001-19
比較
引用符で囲まれた文字列は、等価または不等式と比較できます。整数とバージョン番号は、算術的に比較することもできます。比較演算子は記号または頭字語として表現できます。頭字語は、オープン形式のプロファイルで条件を表現するのに便利です。
演算子 |
代替シンタックス |
説明 |
整数およびバージョンのオペランドに適用可能 |
引用文字列オペランドに適用可能 |
---|---|---|---|---|
= |
EQ (企業) |
等しい: |
可 |
可 |
!= |
の |
等しくない: |
可 |
可 |
< |
lt; |
より小さい |
はい |
いいえ |
<= |
の |
以下と等しい: |
はい |
いいえ |
> |
gt; |
より大きい |
はい |
いいえ |
>= |
geさん |
以上または等しい |
はい |
いいえ |
と |
|
と |
可 |
可 |
文字列リテラルが期待される場合は、マクロ変数を二重引用符で囲むことが重要です。番号またはバージョン番号が予想される場合は使用しないでください。
Profile_Rule* と Upgrade_Rule パラメータのコンテキストで使用する場合、このアップグレード ルールの例のように、条件式をシンタックス「(expr)?」内に囲む必要があります。BN をアップグレードするファームウェア ロードのビルド番号に置き換えてください。
($SWVER は 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]] ファイルパス
スキーム
は次のいずれかの値になります。
-
TFTP
-
http
-
https
スキーム
が省略された場合、tftp が想定されます。サーバは、DNS で認識されるホスト名または数字の IP アドレスにすることができます。ポートは宛先 UDP または TCP ポート番号です。ファイルパスはルートディレクトリ(/)で始まる必要があります。絶対パスである必要があります。
サーバー
が見つからない場合、DHCP (オプション 66) で指定された tftp サーバーが使用されます。
アップグレードルールの場合、サーバを指定する必要があります。
ポート
がない場合、指定されたスキーム用の標準ポートが使用されます。Tftp は UDP ポート 69、http は TCP ポート 80、https は TCP ポート 443 を使用します。
ファイルパスが存在する必要があります。静的ファイルを参照する必要はありませんが、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)を知っているエンティティのみがペイロードを読み取ることができます。電話機が IKM を使用してプロビジョニングされている場合、電話機とプロビジョニング サーバは設定ファイルを安全に交換できますが、サードパーティのネットワーク要素は分析および監視の目的でメッセージ ヘッダーを使用できます。
XML 設定パラメータ IKM_HTTP_Encrypt_Content
は、電話機に IKM を保持します。セキュリティ上の理由から、このパラメータは、電話機の管理 Web ページではアクセスできません。電話機の IP アドレスまたはプロビジョニング サーバに送信された電話機の設定レポートからアクセスできる電話機の設定ファイルにも表示されません。
RFC 8188 ベースの暗号化を使用する場合は、次のことを確認してください。
-
プロビジョニング サーバから電話機に送信される設定ファイルで XML パラメータ
IKM_HTTP_Encrypt_コンテンツ
を使用して IKM を指定することで、IKM で電話機をプロビジョニングします。 -
この暗号化がプロビジョニング サーバーから電話機に送信される設定ファイルに適用される場合は、設定ファイルの Content-Encoding HTTP ヘッダーに
aes128gcm
があることを確認してください。このヘッダーがない場合、AES-256-CBC メソッドが優先されます。電話機は、IKM に関係なく、プロファイルルールに AES-256-CBC キーが存在する場合、AES-256-CBC 復号化を適用します。
-
電話機がこの暗号化をプロビジョニング サーバに送信する設定レポートに適用する場合は、レポート ルールで指定されている AES-256-CBC キーがないことを確認します。
オプションの再同期引数
オプションの引数、key
、uid
、pwd
は、Profile_Rule*
パラメータに入力された URL の前に角括弧で囲んでまとめて指定できます。
キー
--key
オプションは、ファイル内の Content-Encoding ヘッダーが aes128gcm
暗号化を示さない限り、プロビジョニング サーバーから受信する設定ファイルが AES-256-CBC 暗号化で暗号化されていることを電話機に伝えます。キー自体は、用語 --key
の後の文字列として指定されます。必要に応じて、二重引用符(")で囲むことができます。電話機はキーを使用して設定ファイルを復号します。
使用例
[--key VerySecretValue] [--key “my secret phrase”] [--key a37d2fb9055c1d04883a0745eb0917a4]
括弧付きのオプション引数はマクロ展開されます。特別な目的パラメータ GPP_SA ~ GPP_SD は、主要なオプションの引数として使用される場合にのみマクロ変数 $SA ~ $SD にマクロ展開されます。次の例を参照してください。
[--key $SC] [--KEY “$SD”]
オープン形式のプロファイルでは、--key の引数は openssl に与えられた -k オプションの引数と同じである必要があります。
uid と pwd
uid および pwd オプションを使用して、指定された URL が要求されたときに HTTP Basic およびダイジェスト認証の課題に応答して送信されるユーザー ID とパスワードを指定できます。括弧付きのオプション引数はマクロ展開されます。特別な目的パラメータ GPP_SA ~ GPP_SD は、主要なオプションの引数として使用される場合にのみマクロ変数 $SA ~ $SD にマクロ展開されます。次の例を参照してください。
GPP_SA = マイユーザー ID 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,[,oni,3/offi,3[,oni,4/offi,4[,oni,5/offi,5[,oni,6/offi,6]]]]]]) でセクションとして知られています。
-
oni、j および offi、j はセグメントのオン/オフ期間です。i = 1 または 2、j = 1 ~ 6 です。
-
Di はセクションの合計継続時間 (秒単位) です。
すべての継続時間には、1 ms の解像度を提供するために、最大 3 つの小数点以下を指定できます。ワイルドカード文字「*」は無期限を意味します。セクション内のセグメントは順番に再生され、合計継続時間が再生されるまで繰り返されます。
例 1:
60(2/4) 頻度のセクション = 1 頻度のセクション 1: セクション長 = 60 s セグメントの数 = 1 セグメント 1: On=2s、Off=4s 合計リング長 = 60s
例 2:特殊呼出音(short、short、short、long):
60(.2/.2,.2/.2,.2/.2,1/4) パターン セクション数 = 1 パターン セクション 1: セクション長 = 60s セグメント数 = 4 セグメント 1: On=0.2s、Off=0.2s セグメント 2: On=0.2s、Off=0.2s セグメント 3: On=0.2s、Off=0.2s セグメント 4: On=1.0s、Off=4.0s 合計リング長 = 60s
-
-
DialPlanScript:回線 1 と回線 2 のダイヤル プランを指定するために使用されるスクリプト シンタックス。
-
浮動小数点数 - 最大 n 個の 10 進数を持つ浮動小数点値。
-
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 周波数数 = 1 周波数 1 = –10 dBm で 440 Hz
例 2:ダイヤル トーン:
350@-19,440@-19 周波数数 = 2 周波数 1 = –19 dBm で 350 Hz 周波数 2 = –440 Hz
-
-
[IP]:x.x.x.x の形式で有効な IPv4 アドレス。x は 0 ~ 255 です。例:10.1.2.100.
-
[ユーザID]:URL に表示されるユーザ ID(最大 63 文字)。
-
電話:14081234567、*69、*72、345678 などの電話番号文字列、または 1234@10.10.10.100:5068 または jsmith@Cisco.com などの汎用 URL。文字列には、最大 39 文字を使用できます。
-
PhTmplt:電話番号テンプレート。各テンプレートには、カンマ(,)で区切られた 1 つ以上のパターンを含めることができます。各パターンの先頭にある空白は無視されます。「?」と「*」はワイルドカード文字を表します。文字どおりに表すには、%xx. For example, %2a は * を表します。テンプレートには、最大 39 文字を使用できます。例: “1408*, 1510*”, “1408123????, 555?1.”
-
[ポート(Port)]:TCP/UDP ポート番号(0-65535)。10 進数または 16 進数形式で指定できます。
-
ProvisioningRuleSyntax:設定再同期とファームウェア アップグレード ルールを定義するために使用されるスクリプティングシンタックス。
-
PwrLevel: –13.5 または 1.5(dBm)など、小数点以下 1 桁の dBm で表される電力レベル。
-
RscTmplt:「404, 5*」、「61?」、「407、408、487、481」などの SIP 応答ステータス コードのテンプレート。最大 39 文字を含むことができます。
-
Sig:署名された n ビット値。10 進数または 16 進数形式で指定できます。「-」記号は負の値の前にする必要があります。正の値より前の + 記号は任意です。
-
スターコード - *69 などの補足サービスのアクティベーションコード。コードには 7 文字まで入力できます。
-
Str:予約なし文字最大 n 個の汎用文字列。
-
時間 - 秒単位の時間。小数点以下 n 個までです。追加で指定された小数点以下の桁は無視されます。
-
[ToneScript]:コールプログレス トーンの頻度、レベル、および頻度のパラメータを指定するミニスクリプト。スクリプトには、127 文字まで入力できます。
構文: FreqScript;Z1[;Z2]。
セクション Z1 は、CadScript の S1 セクションに似ていますが、各 on/off セグメントに続いて周波数コンポーネント パラメータが続く点が異なります。zー1 = d1(日)i、1/オフi、1/fi、1[,オンi,2/オフi,2/fi,2 [,オンi,3/オフi,3/fi,3 [,オンi,4/オフi,4/fi,4 [,オンi,5/オフi,5/fi,5 [,オンi,6 さん/オフi,6 さん/fi,6 さん]]]]]):
-
fi,j = n1[+n2]+n3[+n4[+n5[+n6]]]]]]。
-
1 < nk < 6 は、そのセグメントで使用される FreqScript の周波数コンポーネントを指定します。
セグメントで複数の周波数コンポーネントが使用されている場合、コンポーネントは合計されます。
例 1:ダイヤル トーン:
350@-19,440@-19;10(*/0/1+2) 周波数 = 2 周波数 1 = –19 dBm で 350 Hz 周波数 2 = –19 dBm で 440 Hz 周波数セクション = 1 周波数セクション 1: セクション長 = 10 s セグメントの数 = 1 セグメント 1: On=forever、周波数 1 と 2 のトーン長 = 10秒
例 2:断続トーン:
350@-19,440@-19;2(.1/.1/1+2);10(*/0/1+2) 周波数数 = 2 周波数 1 = –19 dBm で 350 Hz 周波数 2 = –19 dBm で 440 Hz 周波数数 = 2 周波数セクション 1: セクション長 = 2s セグメントの数 = 1 セグメント 1: On=0.1s、Off=0.1s で頻度 1 および 2 の頻度のセクション 2: セクション長 = 10 s セグメントの数 = 1 セグメント 1: On=forever、周波数 1 と 2 のトーン長 = 12秒
-
-
Uns—符号なしの n ビット値。ただし、n = 8、16、または 32。値は n ビットに収まる限り、12 や 0x18 などの 10 進数または 16 進数形式で指定できます。
以下の点を考慮に入れておいてください。
- は、設定パラメータ名を表します。プロファイルでは、対応するタグは、スペースをアンダースコア「_」に置き換えて作成されます。ar_Name
- 空のデフォルト値フィールドは、空の文字列 < “” > を意味します。
- 電話機は、指定されたプロファイル内に存在しないタグに最後に設定された値を引き続き使用します。
- テンプレートは指定された順序で比較されます。1 番目の最も近いではなく、一致が選択されています。パラメータ名は正確に一致する必要があります。
- プロファイルでパラメータに複数の定義が指定されている場合、ファイル内の最後の定義が電話機で有効になります。
- 空のパラメータ値を持つパラメータ仕様では、パラメータがデフォルト値に戻されます。代わりに空の文字列を指定するには、空の文字列「」をパラメータ値として使用します。