- ホーム
- /
- 投稿記事
9800シリーズと8875電話のプロファイル設定を行います(BroadWorks)
このヘルプ記事は、シスコブロードワークスに登録されているシスコデスクフォン9800シリーズとシスコビデオフォン8875を対象としています。このページの情報には、プロファイルの再同期、プロファイルの手動適用、および設定構文が含まれます。
プロファイルを再同期するように電話を設定してください
TFTP経由で電話プロファイルを再同期します
この電話は、設定プロファイルを取得するための複数のネットワークプロトコルをサポートしています。 最も基本的なプロファイル転送プロトコルはTFTP(RFC1350)です。 TFTPは、プライベートLANネットワーク内のネットワークデバイスのプロビジョニングに広く使用されています。 インターネットを介したリモートエンドポイントの導入にはお勧めしませんが、TFTPは小規模組織内での導入、社内での事前プロビジョニング、開発とテストには便利です。 次の手順では、TFTPサーバーからファイルをダウンロードした後にプロファイルを変更します。
| 1 |
LAN環境では、コンピューターと電話をハブ、スイッチ、または小型ルーターに接続します。 |
| 2 |
コンピューターに、TFTPサーバーをインストールしてアクティブにします。 |
| 3 |
テキストエディタを使って設定プロファイルを作成してください。 プロファイルが携帯電話にプロビジョニングされたかどうかを後で確認するには、いくつかの値をマークとして設定できます。 たとえば、次の例に示すように、GPP_Aの値を12345678に設定します。
|
| 4 |
XML設定ファイルをTFTPサーバーのルートディレクトリに保存します。 TFTPサーバーが正しく構成されていることを確認できます。電話以外のTFTPクライアントを使用して構成プロファイルファイルをリクエストしてください。 できれば、プロビジョニングサーバーとは別のホストで実行されているTFTPクライアントを使用してください。 |
| 5 |
パソコンのウェブブラウザで、管理ウェブページを開きます。 たとえば、電話の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 |
パラメータが正しく更新されていることを確認してください。 管理ウェブページを更新して、。 これで、GPP_Aパラメーターに12345678という値が含まれているはずです。 |
TFTPサーバーで電話機固有のプロファイルをプロビジョニングします
| 1 |
製品ラベルから電話のMACアドレスを取得してください。 (MACアドレスは、数字と小文字の16進数を使った番号です。たとえば、000e08aabbccです。 |
| 2 |
例:
|
| 3 |
新しいファイルをTFTPサーバーの仮想ルートディレクトリに移動します。 |
| 4 |
電話管理ウェブページにアクセスしてください。 |
| 5 |
[] を選択します。 |
| 6 |
「プロファイルルール」フィールドにプロファイルファイルのパスを入力します。 例:TFTPサーバーのIPアドレスが192.168.1.200で、プロファイルのファイル名が
|
| 7 |
「すべての変更を送信」をクリックします。 これにより、すぐに再起動して再同期されます。 次の再同期が発生すると、電話は $MA マクロ式を MAC アドレスに展開して新しいファイルを取得します。 |
電話プロファイルを HTTP GET と再同期してください
| 1 |
ローカルコンピューターまたは他のアクセス可能なホストにHTTPサーバーをインストールします。 オープンソースのApacheサーバーはインターネットからダウンロードできます。 |
| 2 |
設定プロファイルファイルを、インストールしたサーバーの仮想ルートディレクトリにアップロードします。 |
| 3 |
サーバーが適切にインストールされ、プロファイルファイルへのアクセスを確認するには、ウェブブラウザでプロファイルを開きます。 |
| 4 |
テスト電話のProfile_Ruleを変更して、TFTPサーバーの代わりにHTTPサーバーを指すようにして、プロファイルを定期的にダウンロードします。 たとえば、HTTP サーバーが 192.168.1.300 で、プロファイルのファイル名が basic.txt だとすると、次の値を入力します。
|
| 5 |
「すべての変更を送信」をクリックします。 これにより、すぐに再起動して再同期されます。 |
| 6 |
電話が送信するSyslogメッセージを観察してください。 これで、定期的な再同期で、HTTPサーバーからプロファイルが取得されるはずです。 |
| 7 |
HTTPサーバーのログで、テスト電話を識別する情報がユーザーエージェントのログにどのように表示されるかを観察してください。 この情報には、メーカー、製品名、現在のファームウェアバージョン、シリアル番号を含める必要があります。 |
電話プロファイルを自動的に再同期します
デバイスは定期的にプロビジョニングサーバーと再同期して、サーバー上で行われたプロファイルの変更がエンドポイントデバイスに確実に伝わるようにすることができます(エンドポイントに明示的な再同期要求を送信するのではなく)。
電話機をサーバーと定期的に再同期させるには、設定プロファイルのURLをProfile_Ruleパラメーターで定義し、再同期期間をResync_Periodicパラメーターを使用して定義します。
| 1 |
電話管理ウェブページにアクセスしてください。 |
| 2 |
[] を選択します。 |
| 3 |
Profile_Ruleパラメーターを定義してください。 この例では、TFTPサーバーのIPアドレスが192.168.1.200であることを前提としています。 |
| 4 |
「定期再同期」フィールドに、30秒など、テスト用の小さな値を入力します。 |
| 5 |
「すべての変更を送信」をクリックします。 新しいパラメータ設定では、電話はURLで指定された設定ファイルに1分間に2回再同期します。 |
| 6 |
Syslogトレースで結果のメッセージを確認してください。 |
| 7 |
「リセット時に再同期」 フィールドが 「はい」 に設定されていることを確認してください。
|
| 8 |
電話の電源を入れ直して、プロビジョニングサーバーと強制的に再同期させます。 サーバーが応答しないなど、何らかの理由で再同期操作が失敗した場合、ユニットは(再同期エラー再試行遅延で設定された秒数の間)待機してから再同期を試みます。 再同期エラー再試行遅延時間がゼロの場合、電話は再同期に失敗した後も再同期を試みません。 |
| 9 |
(オプション)再同期エラー再試行遅延フィールドの値を、30などの小さい数値に設定します。
|
| 10 |
TFTPサーバーを無効にして、syslog出力の結果を確認してください。 |
プロファイルの再同期パラメーター
次の表は、電話機のWebページの「」タブの「構成プロファイル」セクションにあるプロファイル再同期パラメータの機能と使用方法を定義しています。 また、パラメータを設定するためにXMLコードを使用して電話設定ファイル(cfg.xml)に追加される文字列の構文も定義します。
|
パラメーター |
説明 |
|---|---|
|
プロビジョニングを有効にする |
設定プロファイルの再同期アクションを許可または拒否します。
デフォルト:はい |
|
リセット時に再同期 |
電源投入後とアップグレードのたびに、電話機が設定をプロビジョニングサーバーと再同期するかどうかを指定します。
デフォルト:はい |
|
再同期のランダム遅延 |
多数のデバイスの電源が同時に入って初期設定を試みたときに、プロビジョニングサーバーが過負荷になるのを防ぎます。 この遅延は、デバイスの電源投入またはリセット後の初期設定時にのみ有効です。 パラメータは、デバイスがプロビジョニングサーバーと通信する前に待機する最大時間間隔です。 実際の遅延は、0からこの値の間の疑似乱数です。 このパラメータは20秒単位です。 有効な値の範囲は0から65535です。
デフォルト値は2 (40秒) です。 |
|
で再同期(うーん) |
電話がプロビジョニングサーバーと再同期する時間(うーん)。 このフィールドの値は、HHmm形式の時間を示すために0000から2400までの4桁の数字でなければなりません。 たとえば、0959は 09:59 を示します。
デフォルト値は空です。 値が無効な場合、パラメータは無視されます。 このパラメータに有効な値を設定すると、Resync Periodic パラメータは無視されます。 |
|
ランダムな遅延で再同期します |
多数のデバイスの電源が同時にオンになったときに、プロビジョニングサーバーが過負荷になるのを防ぎます。 複数の電話からサーバーへの再同期要求が殺到しないように、電話は時間と分、時間と分にランダムな遅延(hhmm、hhmm+random_delay)を加えた範囲で再同期します。 たとえば、ランダム遅延 = (ランダム遅延での再同期 + 30) /60分の場合、秒単位の入力値が分単位に変換され、次の分まで切り上げられて最終的なrandom_delay間隔が計算されます。
有効な値の範囲は600から65535です。 値が600未満の場合、内部のランダム遅延は0から600の間です。 デフォルト値は600秒(10分)です。 |
|
定期再同期 |
プロビジョニングサーバーとの定期的な再同期の間の時間間隔。 関連する再同期タイマーは、サーバーとの最初の同期が成功した後にのみアクティブになります。 有効な形式は次のとおりです。
定期的な再同期を無効にするには、このパラメータをゼロに設定してください。 デフォルト値は3600秒です。 |
|
再同期エラー再試行遅延 |
電話機がサーバーからプロファイルを取得できなかったり、ダウンロードしたファイルが破損していたり、内部エラーが発生したりして、再同期操作が失敗した場合、電話機は秒単位で指定された時間が経過した後に再同期を試みます。 有効な形式は次のとおりです。
遅延が0に設定されている場合、デバイスは再同期に失敗した後も再同期を試みません。
デフォルト:60,120,240,480,960,1920,3840,7680,15360,30720,61440,86400 |
|
強制再同期遅延 |
再同期を実行する前に電話が待機する最大遅延(秒単位)。 電話回線の1つがアクティブな間は、デバイスは再同期しません。 再同期には数秒かかることがあるので、再同期する前にデバイスが長時間アイドル状態になるまで待つことをお勧めします。 これにより、ユーザーは中断することなく連続して電話をかけることができます。 このデバイスには、すべての回線がアイドル状態になるとカウントダウンを開始するタイマーがあります。 このパラメータはカウンターの初期値です。 再同期イベントは、このカウンタがゼロになるまで遅延されます。 有効な値の範囲は0から65535です。
デフォルト値は14,400秒です。 |
|
SIPから再同期 |
サービスプロバイダーのプロキシサーバーから電話に送信されるSIP NOTIFYイベントを介して、再同期操作のリクエストを制御します。 有効にすると、プロキシはEvent: resyncヘッダーを含むSIP NOTIFYメッセージをデバイスに送信して再同期を要求できます。
デフォルト:はい |
|
アップグレードを試みた後に再同期します |
アップグレードが行われた後の再同期操作を有効または無効にします。 はいを選択すると、ファームウェアのアップグレード後に同期が開始されます。
デフォルト:はい |
|
再同期トリガー 1 再同期トリガー 2 |
これらのパラメーターの論理式がFALSEと評価された場合、リセット時の再同期がTRUEに設定されていても再同期はトリガーされません。 これらの再同期トリガーを無視するのは、ダイレクトアクションURLとSIP通知による再同期だけです。 パラメータは、マクロ展開を行う条件式でプログラムできます。 有効なマクロ展開については、「プロビジョニングパラメーター」の「マクロ展開変数」を参照してください。
デフォルト:空白 |
|
ユーザー設定可能な再同期 |
ユーザーが電話スクリーンメニューから電話を再同期できるようにします。 「はい」 に設定すると、ユーザーは電話からプロファイルルールを入力することで、電話の設定を再同期できます。 「いいえ」に設定すると、プロファイルルールパラメータは電話スクリーンのメニューに表示されません。
デフォルト:はい |
|
FNFで再同期が失敗する |
要求されたプロファイルがサーバーから受信されない場合、再同期は通常、失敗したと見なされます。 このパラメータはこの動作をオーバーライドします。 「いいえ」に設定すると、
デフォルト:はい |
|
プロフィール認証タイプ |
プロファイルアカウント認証に使用する資格情報を指定します。 利用できるオプションは次のとおりです。
デフォルト:基本的な HTTP 認証 詳細については、「プロファイルの再同期を行う電話を指定する」の「プロファイル認証タイプの指定」を参照してください。 |
|
プロフィールルール プロファイルルールB プロファイルルールC プロファイルルールD |
各プロファイルルールは、プロファイル(設定ファイル)を取得するソースを電話に通知します。 再同期操作のたびに、電話はすべてのプロファイルを順番に適用します。
オプションで、暗号化キーを二重引用符(「)で囲むことができます。
デフォルト: |
|
使用するDHCPオプション |
ファームウェアとプロファイルを取得するために使用される、カンマで区切られたDHCPオプション。 デフォルト:66,160,159,150,60,43,125 |
|
DHCPv6オプションを使用してください |
ファームウェアとプロファイルを取得するために使用される、カンマで区切られたDHCPオプション。 デフォルト:17,160,159です |
シスコ XML によるプロビジョニング
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 解像度
サーバー上に複数のプロファイルを持つサブディレクトリは、導入された多数のデバイスを管理するのに便利です。 プロフィールURLには以下を含めることができます:
-
プロビジョニングサーバー名または明示的なIPアドレス。 プロファイルがプロビジョニングサーバーを名前で識別する場合、電話はDNSルックアップを実行して名前を解決します。
-
サーバー名の後に続く標準構文:portを使用してURLで指定されている非標準のサーバーポート。 -
プロファイルが保存されているサーバーの仮想ルートディレクトリのサブディレクトリで、標準のURL表記を使用して指定され、マクロ展開で管理されます。
たとえば、次のProfile_Ruleは、サーバーサブディレクトリ/cisco/configにあるプロファイルファイル($pn.cfg)を、ホストprov.telco.com上で実行されているTFTPサーバーから、ポート6900での接続を待っています。
<Profile_Rule>
tftp://prov.telco.com:6900/cisco/config/$PN.cfg
</Profile_Rule>
各電話のプロファイルは汎用パラメータで識別でき、その値はマクロ展開を使用して共通のプロファイルルールで参照できます。
たとえば、GPP_BがDj6Lmp23Qとして定義されているとします。
プロファイルルールには次の値があります。
tftp://prov.telco.com/cisco/$B/$MA.cfg
デバイスが再同期されてマクロが展開されると、MACアドレスが000e08012345の電話は、次のURLにあるデバイスのMACアドレスを含む名前のプロファイルを要求します。
tftp://prov.telco.com/cisco/Dj6Lmp23Q/000e08012345.cfg
プロファイルの認証タイプを指定してください
プロファイル認証により、電話ユーザーはプロビジョニングプロファイルを電話に再同期できます。 電話機が設定ファイルを初めて再同期してダウンロードしようとしたときに、HTTPまたはHTTPS 401の認証エラーが発生した場合は、認証情報が必要です。 この機能を有効にすると、次のような場合にプロフィールアカウントの設定画面が電話に表示されます。
-
電話機の再起動後の初回プロビジョニング中に HTTP または HTTPS 401 認証エラーが発生した場合
-
プロフィール、アカウントのユーザー名とパスワードが空の場合
-
プロファイルルールにユーザー名とパスワードがない場合
プロフィールアカウントの設定画面が見当たらなかったり無視されたりした場合、ユーザーは電話画面メニューまたはセットアップソフトキーから設定画面にアクセスすることもできます。セットアップソフトキーは、電話の回線が登録されていない場合にのみ表示されます。
この機能を無効にすると、プロフィールアカウントの設定画面が電話に表示されません。
プロファイルルールフィールドのユーザー名とパスワードは、プロファイルアカウントよりも優先されます。
-
ユーザー名とパスワードなしでプロファイルルールフィールドに正しいURLを入力すると、電話機はプロファイルを再同期するために認証またはダイジェストを要求します。 正しいプロフィールアカウントがあれば、認証は成功します。 プロフィールアカウントが正しくないと、認証は失敗します。
-
プロファイルルールフィールドに正しいユーザー名とパスワードを使用して正しいURLを入力すると、電話機はプロファイルを再同期するために認証またはダイジェストを要求します。 プロフィールアカウントは電話の再同期には使用されません。 サインインは成功しました。
-
プロファイルルールフィールドに正しいURLを入力し、間違ったユーザー名とパスワードを入力すると、電話機はプロファイルを再同期するために認証またはダイジェストを要求します。 プロフィールアカウントは電話の再同期には使用されません。 サインインは常に失敗します。
-
プロファイルルールフィールドに間違ったURLを入力すると、サインインは常に失敗します。
XML(cfg.xml)コードを使用して、電話設定ファイルのパラメータを設定することもできます。
電話管理Webページからプロファイルの認証タイプを指定できます。
| 1 |
電話管理ウェブページにアクセスしてください。 |
| 2 |
[] を選択します。 |
| 3 |
「構成プロファイル」セクションで、「プロファイル認証タイプ」パラメーターを設定して、プロファイルアカウント認証に使用する資格情報を指定します。 このパラメータは、 次の形式の文字列を入力することで、電話設定のXMLファイル(cfg.xml) に設定できます。
オプション:
デフォルト:基本的な HTTP 認証 |
| 4 |
「すべての変更を送信」をクリックします。 |
プロファイルを携帯電話に手動で適用してください
TFTPサーバーから設定ファイルを電話にダウンロードします
PCのTFTPサーバーアプリケーションに設定ファイルをダウンロードするには、次の手順を実行してください。
| 1 |
コンピューターを電話のLANポートに接続します。 |
| 2 |
コンピュータ上でTFTPサーバーアプリケーションを実行し、設定ファイルがTFTPルートディレクトリにあることを確認します。 |
| 3 |
ウェブブラウザで、電話LANのIPアドレス、コンピュータのIPアドレス、ファイル名、ログイン認証情報を入力します。 この形式を使う:
例:
|
cURLを使用して設定ファイルを電話にダウンロードします
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アルゴリズム(RFC1951)を使用してファイルを圧縮できます。
ファイルは、次の暗号化方法のいずれかで暗号化できます。
-
AES-256-CBC 暗号化システム
-
AES-128-GCM暗号化によるRFC-8188ベースのHTTPコンテンツ暗号化です
設定ファイルには次のコンポーネントを含めることができます。
-
要素タグ
-
属性
-
パラメーター
-
フォーマット機能
-
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では、同じ設定を行うことができます。 Web UIのXMLタグ名とフィールド名は似ていますが、XML要素名の制限により異なります。 たとえば、Web UIではスペースの代わりにXML設定ファイルではアンダースコア(_)を付けます。
-
<flat-profile>電話は、特別な要素にカプセル化された適切なパラメータ名を持つ要素を認識します。
-
要素名は山括弧で囲まれています。
-
ほとんどの要素名は電話機のWeb UIのフィールド名と似ていますが、次の点が異なります。
-
要素名にスペースや特殊文字を含めることはできません。
ウェブフィールド名から要素名を導き出すには、すべてのスペースにアンダースコアを使用するか、特殊文字[、]、(、)、/をアンダースコアに置き換えてください。例:<Resync_On_Reset>この要素は「リセット時に再同期」 フィールドを表します。
-
各要素名は一意でなければなりません。 電話機のWeb UIでは、回線、ユーザー、内線ページなど、同じフィールドを複数のWebページに表示できます。 要素名に
[n]を追加して、ページタブに表示される番号を示します。例:
<Dial_Plan_1_>この要素は回線 1 のダイヤルプランを表します。
-
-
各開始要素タグには、対応する終了要素タグが必要です。 例えば:
<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つ指定することをお勧めします。
最後に処理されたプロファイルが優先されます。 複数のプロファイルが同じ設定パラメータを指定している場合は、後者のプロファイルの値が優先されます。
文字列フォーマット
これらのプロパティは文字列のフォーマットに適用されます。
コメントは標準のXML構文でも使用できます。
<!-- My comment is typed here -->先頭と末尾の空白は読みやすくするために許可されていますが、パラメーター値からは削除されています。
値内の改行はスペースに変換されます。
<? という形式のXMLヘッダー?> は許可されていますが、電話はそれを無視します。特殊文字を入力するには、次の表に示すように、基本的なXML文字エスケープを使用してください。
特殊文字
XML エスケープシーケンス
& (アンパサンド)
&
< (以下)
<
>(より大きい)
>
'(アポストロフィ)
'
」(二重引用符)
「
次の例では、ダイヤルプランルールに必要な大なり記号と小なり記号を表すエスケープ文字を入力しています。 この例では、<Dial_Plan_1_>パラメーター ( に設定する情報ホットラインのダイヤルプランを定義しています。
<flat-profile> <Dial_Plan_1_> (S0 <:18005551212>) </Dial_Plan_1_> </flat-profile>10進数と16進数の値(s.a.(と.)を使った数字のエスケープが翻訳されています。電話ファームウェアはASCII文字のみをサポートしています。
オープンプロファイル圧縮
サポートされている圧縮方法は、gzip デフレートアルゴリズム(RFC1951)です。 同じアルゴリズム(zlib)を実装するgzipユーティリティと圧縮ライブラリは、インターネットサイトから入手できます。
圧縮を識別するために、電話機は圧縮ファイルにgzip互換のヘッダーが含まれていることを期待しています。 元のオープンプロファイルでgzipユーティリティを呼び出すと、ヘッダーが生成されます。 電話機はダウンロードしたファイルヘッダーを調べてファイル形式を決定します。
たとえば、profile.xml が有効なプロファイルであれば、profile.xml.gz ファイルも受け入れられます。 次のコマンドのどちらでも、この種類のプロファイルを生成できます。
-
>gzip profile.xml元のファイルを圧縮ファイルに置き換えます。
-
>cat profile.xml | gzip > プロファイル.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バージョンに対してテストされています。
暗号化されたファイルの場合、プロファイルは次のコマンドで生成されたのと同じ形式であることを前提としています。
# 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ビットソルトを生成するために使用されます。 -k引数で指定されたシークレットを使用して、暗号化ツールはランダムな128ビットの初期ベクトルと実際の256ビットの暗号化キーを導き出します。
この形式の暗号化を設定プロファイルで使用する場合、ファイルを復号化するには秘密鍵の値を電話に通知する必要があります。 この値は、プロファイルURLの修飾子として指定されます。 構文は次のとおりです。明示的なURLを使用します。
[--key “SecretPhrase1234”] http://prov.telco.com/path/profile.cfg
この値は、Profile_Ruleパラメーターの1つを使用してプログラムされます。
いくつかのプロビジョニングパラメータは、評価される前に内部でマクロ展開されます。 この事前評価ステップにより、電話の再同期とアップグレードのアクティビティをより柔軟に制御できます。
これらのパラメータグループは、評価前にマクロ展開されます。
-
再同期_トリガー_*
-
プロフィール_ルール*
-
ログ_XXX_MSG
-
アップグレード_ルール
特定の条件下では、下記の「オプションの再同期引数」セクションに明記されているように、一部の汎用パラメータ(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までのマクロ式にマップされます。 これらのパラメータは、再同期URLの--key、--uid 、--pwdオプションの引数としてマクロ展開されるだけです。
条件式は再同期イベントをトリガーしたり、再同期やアップグレード操作の代替URLを選択したりできます。
条件式は、and 演算子で区切られた比較リストで構成されます。 条件を満たすには、すべての比較を満たす必要があります。
各比較は、次の3種類のリテラルのいずれかに関連付けることができます。
-
整数値
-
ソフトウェアまたはハードウェアのバージョン番号
-
二重引用符で囲まれた文字列
バージョン番号
Ciscoビデオ電話8875のソフトウェアバージョンは次の形式を使用しています(BNはビルド番号)。
電話 yyyy。1-0-1-0001 -BN
ここで、yyyyは電話モデルまたは電話シリーズ、1はメジャーバージョン、0はマイナーバージョン、1-0001はマイクロバージョン、BNはビルド番号です。
比較文字列は同じ形式を使用する必要があります。 そうしないと、フォーマット解析エラーになります。
ソフトウェアバージョンを比較するときは、メジャーバージョン、マイナーバージョン、マイクロバージョンが順番に比較され、左端の数字が後者の数字よりも優先されます。 バージョン番号が同じ場合は、ビルド番号が比較されます。
有効なバージョン番号の例
PHONEOS-8875.1-0-1-0001-19
比較
引用符で囲まれた文字列は、等しいか等しくないかを比較できます。 整数とバージョン番号は算術的に比較することもできます。 比較演算子は、記号または頭字語で表すことができます。 略語は、オープンフォーマットのプロファイルで状態を表現するのに便利です。
|
オペレーター |
代替構文 |
説明 |
整数オペランドとバージョンオペランドに適用できます |
引用符で囲まれた文字列オペランドに適用できます |
|---|---|---|---|---|
|
= |
eq |
と等しい |
はい |
はい |
|
!= |
ね |
と等しくない |
はい |
はい |
|
< |
lt |
より小さい |
はい |
いいえ |
|
<= |
ル |
より小さい、または等しい |
はい |
いいえ |
|
> |
gt |
より大きい |
はい |
いいえ |
|
>= |
年齢 |
より大きい、または等しい |
はい |
いいえ |
|
AND |
|
と |
はい |
はい |
文字列リテラルが必要な場所では、マクロ変数を二重引用符で囲むことが重要です。 番号やバージョン番号が必要な場合はそうしないでください。
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構文を使用して、Profile_Rule*とUpgrade_Ruleパラメーターで設定ファイルの取得方法とファームウェアのロード方法をそれぞれ指定します。 構文は以下の通りです:
[スキーム://] [サーバー [: ポート]] ファイルパス
ここで、schemeは次の値のいずれかです:
-
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がプロビジョニングされると、電話機とプロビジョニングサーバーは設定ファイルを安全に交換でき、サードパーティのネットワーク要素はメッセージヘッダーを分析や監視に使用できるようになります。
IKM_HTTP_Encrypt_ContentのXML設定パラメータは、電話機のIKMを保持します。 セキュリティ上の理由から、このパラメータは電話管理ウェブページではアクセスできません。 また、電話の設定ファイルにも表示されません。このファイルには、電話機のIPアドレスから、またはプロビジョニングサーバーに送信される電話の設定レポートからアクセスできます。
RFC 8188 ベースの暗号化を使用する場合は、次の点を確認してください。
-
プロビジョニングサーバーから電話に送信される設定ファイルで、
IKM_HTTP_Encrypt_contentというXMLパラメーターで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オプションを使用して、指定されたURLが要求されたときにHTTPベーシック認証とダイジェスト認証チャレンジに応答して送信されるユーザーIDとパスワードを指定できます。 括弧で囲まれたオプション引数はマクロ展開されています。 GPP_SAからGPP_SDという特殊用途のパラメータは、キーオプション引数として使用される場合にのみ、$SAから$SDまでのマクロ変数にマクロ展開されます。 次の例を見てください。
GPP_SA = MyUserID
GPP_SB = MySecretPassword
[--uid $SA--pwd $SB] https://provisioning_server_url/path_to_your_config/your_config.xml
その後、次のように拡張されます。
[--uid 私のユーザーID--pwdMySecretPassword] https://provisioning_server_url/path_to_your_config/your_config.xml
データタイプ
これらのデータタイプは、構成プロファイルのパラメータで使用されます。
-
{a、b、c、...} —a、b、c、... の中から選択してください
-
ブール —「はい」または「いいえ」のブール値。
-
CadScript—シグナルのケイデンスパラメータを指定するミニスクリプト。 127文字までです。
構文:S 1 [; S 2]、ここで:
-
s i =D i (on i,1 /off i,1 [, on i,2 [, on i,3 /off i,3 [, on i,4 /off i,4 [, on i,5 /off i,5 [, on i,6 /off i,6]]]) であり、セクションと呼ばれます。
-
on i、j、 off i、jは、セグメントのオン/オフ時間(秒単位)です。i = 1または2、j = 1~6です。
-
D Iはセクションの合計時間(秒単位)です。
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のダイヤルプランを指定するために使用されるスクリプト構文。
-
浮動小数点数 <n>—小数点以下n桁までの浮動小数点値。
-
FQDN — 完全修飾ドメイン名。 最大63文字まで入力できます。 例は次のとおりです。
sip.cisco.com: 5060 または 109.12.14. 12:12345
sip.cisco.com または 109.12.14.12
-
FreqScript—トーンの周波数とレベルのパラメーターを指定するミニスクリプト。 127文字まで含まれます。
構文:F 1 @L 1 [, F 2 @L 2 [, F 3 @L 3 [, F 4 @L 4 [, F 5 @L 5 [, F 6 @L 6]]]], どこ:
-
F 1 —F 6はHz単位の周波数です(符号なし整数のみ)。
-
L 1 —L 6は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。
-
ユーザーID — URLに表示されるユーザーID。最大63文字。
-
電話—14081234567、*69、*72、345678などの電話番号文字列、または1234 @10 .10.10などの一般的なURL。100:5068 または jsmith@Cisco.com。 文字列には最大39文字まで含めることができます。
-
PHTMPLT — 電話番号テンプレート。 各テンプレートには、カンマ (,) で区切られた1つまたは複数のパターンを含めることができます。 各パターンの先頭の空白は無視されます。 「?」と「*」はワイルドカード文字を表します。 文字通りに表すには、%xx を使います。 たとえば、%2aは*を表します。 テンプレートには39文字まで含めることができます。 例:「1408*、1510*」、「1408123???、555?1.」。
-
ポート-TCP/UDPポート番号(0-65535)。 10進数または16進形式で指定できます。
-
provisioningRuleSyntax — 設定の再同期とファームウェアのアップグレードルールを定義するために使用されるスクリプト構文。
-
パーレベル—電力レベルはdBmで小数点以下1桁で表されます。—13.5や1.5(dBm)など。
-
RSCTMPLT —「404、5*」、「61?」などのSIPレスポンスステータスコードのテンプレート、「407、408、487、481」。 最大39文字まで入力できます。
-
Sig <n>—符号付きnビット値。 10進数または16進形式で指定できます。 負の値の前には「-」記号を付ける必要があります。 正の値の前の+記号はオプションです。
-
スターコード — *69などの補足サービスのアクティベーションコード。 コードには最大7文字まで入力できます。
-
Str <n>—最大n個の予約されていない文字を含む一般的な文字列。
-
<n>time —秒単位の時間。小数点以下n桁まで。 余分に指定された小数点以下の桁数は無視されます。
-
toneScript—コールプログレストーンの周波数、レベル、およびケイデンスのパラメータを指定するミニスクリプト。 スクリプトには最大127文字まで含めることができます。
構文:フリースクリプト; Z 1 [; Z 2]。
セクションZ 1はCADScriptのS 1セクションと似ていますが、各オン/オフセグメントの後に周波数成分パラメーターが続く点が異なります。Z 1 = D 1 (on i,1 /off i,1 /f i,1 /f i,1 [, on i,2 /off i,2 /f i,2 [, on i,3 /f i,3 [, on i,4 /off i,4 if i,4 [, on i5 /off i,5 /f i,5 [, on i,6 /off i,6 /fi、6]]]]) どこ:
-
f i、j = n 1 [+n 2] +n 3 [+n 4 [+n 5 [+n 6]]]]。
-
1 < n k < 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つのプロファイルにパラメータの定義が複数ある場合、ファイル内の最後の定義が電話で有効になります。
- パラメータ値が空のパラメータ指定は、パラメータを強制的にデフォルト値に戻します。 代わりに空の文字列を指定するには、パラメータ値として空の文字列「」を使用してください。