プロビジョニング パラメータ

プロビジョニング パラメータの概要

この章では、設定プロファイルのスクリプトで使用できるプロビジョニング パラメータについて説明します。

設定プロファイル パラメータ

次の表で、[プロビジョニング(Provisioning)] タブの [設定プロファイルパラメータ(Configuration Profile Parameters)] セクションの各パラメータの機能と使用方法を定義します。

パラメータ名

説明とデフォルト値

[プロビジョン有効(Provision Enable)]

ファームウェア アップグレード操作とは関係なくすべての再同期操作を制御します。 リモート プロビジョニングを有効にするには [はい(Yes)] を設定します。

デフォルト値は [はい(Yes)] です。

[リセット時の再同期(Resync On Reset)]

パラメータの更新やファームウェア アップグレードによるリブートを除き、リブートのたびに再同期がトリガーされます。

デフォルト値は [はい(Yes)] です。

[再同期ランダム遅延(Resync Random Delay)]

秒単位で指定される、リセットを実行する前のブートアップ シーケンスに続くランダム遅延。 同時に電源が投入される予定の IP テレフォニー デバイスのプールでは、これにより、それぞれのユニットがプロビジョニング サーバに再同期要求を送信する時間が延びます。 この機能は、地域の停電時に大規模な宅内導入で役立つ場合があります。

このフィールドの値は、0 から 65535 の範囲の整数でなければなりません。

デフォルト値は 2 です。

[再同期時刻(HHmm)(Resync At (HHmm))]

デバイスをプロビジョニング サーバと再同期する時間(HHmm)。

このフィールドの値は、HHmm 形式で時刻を示すために 0000 から 2400 までの範囲の 4 桁の数字でなければなりません。 たとえば、0959 は 09:59 を示します。

デフォルト値は空です。 値が無効な場合、パラメータは無視されます。 このパラメータに有効な値が設定される場合、[定期再同期(Resync Periodic)] パラメータが無視されます。

[再同期時刻ランダム遅延(Resync At Random Delay)]

多数のデバイスの電源が同時に起動するときの、プロビジョニング サーバの過負荷状態を回避できます。

複数の電話機からサーバへの再同期要求のフラッディングを回避するために、電話機は、時間と分の範囲と、時間と分およびランダム遅延(hhmm、hhmm+random_delay)を再同期します。 例えば、ランダム遅延 = (ランダム遅延での再同期 + 30)/60 分である場合、秒単位で入力すると分に変換され、1 分に満たない秒数は次の分単位に切り上げられて最終的な random_delay の間隔が計算されます。

有効値は 600 から 65535 の範囲です。

値が 600 未満の場合、ランダム遅延内部は 0 ~ 600 です。

デフォルト値は 600 秒(10 分)です。

[定期再同期(Resync Periodic)]

プロビジョニング サーバでの定期的な再同期の時間間隔。 サーバで同期が最初に成功した後にのみ関連付けられている再同期タイマーがアクティブになります。

有効なフォーマットは以下のとおりです。

  • 整数

    例:の入力 3000 次の再同期が 3000 秒以内に行われることを示します。

  • 複数の整数

    例:入力値 600、1200、300 は、最初の再同期が 600 秒後に行われ、2 番目の再同期は最初の再同期から 1200 秒後に行われ、3 番目の再同期は 2 番目の再同期から 300 秒後に行われることを示します。

  • 時間範囲

    例、入力値 2400 + 30 は、再同期が成功した後、2400 秒から 2430 秒後に次の再同期が行われることを示します。

定期再同期を無効にするには、このパラメータを 0 に設定します。

デフォルト値は 3600 秒です。

[再同期エラー再試行遅延(Resync Error Retry Delay)]

IP テレフォニー デバイスがサーバからプロファイルを取得できなかった、またはダウンロードしたファイルが破損している、あるいは内部エラーが発生しているために再同期操作が失敗した場合、デバイスはここで指定した時間(秒単位)が経過した後に再同期を再試行します。

有効なフォーマットは以下のとおりです。

  • 整数

    例: 300の入力は、次の再試行が 300 秒で発生することを示しています。

  • 複数の整数

    例:入力値 600、1200、300 は、最初の再試行が失敗から 600 秒後に行われ、2 回目の再試行が最初の再試行の失敗から 1200 秒後に行われ、3 回目の再試行が 2 回目の再試行の失敗から 300 秒後に行われることを意味します。

  • 時間範囲

    たとえば、入力値 2400 + 30 は、再同期の失敗後、2400 秒から 2430 秒後に次の再試行が行われることを示します。

遅延が 0 に設定されている場合、デバイスは再同期が失敗しても、再同期を再試行しません。

[強制再同期遅延(Forced Resync Delay)]

電話機が再同期を実行するまでの待機時間の最大遅延(秒単位)。

電話回線のいずれかがアクティブな間、デバイスは再同期しません。 再同期には数秒かかるため、デバイスが長時間アイドルになるまで待機してから再同期することをお勧めします。 これにより、ユーザは中断することなく通話できます。

デバイスには、すべての回線がアイドル状態になったときにカウント ダウンを開始するタイマーがあります。 このパラメータは、カウンタの初期値です。 再同期イベントは、このカウンタが 0 になるまで遅延します。

有効値は 0 から 65535 の範囲です。

デフォルト値は 14,400 秒です。

[SIPからの再同期(Resync From SIP)]

SIP NOTIFY メッセージを介して再同期をトリガーできます。

デフォルト値は [はい(Yes)] です。

[アップグレード試行後の再同期(Resync After Upgrade Attempt)]

アップグレードの実行後の再同期操作を有効または無効にします。 [はい(Yes)] を選択すると、同期がトリガーされます。

デフォルト値は [はい(Yes)] です。

[再同期トリガー1、再同期トリガー2(Resync Trigger 1, Resync Trigger 2)]

設定可能な再同期トリガー条件。 これらのパラメータの論理式が TRUE に評価されたときに再同期がトリガーされます。

デフォルト値は(空)です。

[FNF時の再同期失敗(Resync Fails On FNF)]

再同期は、要求されたプロファイルがサーバから受信されなかった場合に失敗と見なされます。 これは、このパラメータで上書きできます。 この値を [いいえ(No)]に設定すると、デバイスはサーバからの file-not-found 応答を正常な再同期として受け入れます。

デフォルト値は [はい(Yes)] です。

[プロファイルルール(Profile Rule)]

[プロファイルルールB(Profile Rule B)]

[プロファイルルールC(Profile Rule C)]

[プロファイルルールD(Profile Rule D)]

各プロファイル ルールは、プロファイル(設定ファイル)を取得するソースを電話機に通知します。 すべての再同期操作の間、電話機はすべてのプロファイルを順番に適用します。

デフォルト:/$PSN.xml

構成ファイルに AES-256-CBC 暗号化を適用する場合は、次のように - キーキーワード付きの暗号キーを指定します。

[--key <encryption key>]

オプションで暗号キーを二重引用符(&quot;)で囲むことができます。

[使用するDHCPオプション(DHCP Option To Use)]

ファームウェアおよびプロファイルを取得するために使用される、コンマで区切られた DHCP オプション。

デフォルト値は、66、160、159、150、60、43、125 です。

[ログ要求メッセージ(Log Request Msg)]

このパラメータには、再同期の試行開始時に syslog サーバに送信されるメッセージが含まれます。

デフォルト値は $PN $MAC –Requesting % $SCHEME://$SERVIP:$PORT$PATH です。

[ログ成功メッセージ(Log Success Msg)]

再同期の試行が正常に完了した時点で発行される syslog メッセージ。

デフォルト値は $PN $MAC –Successful Resync % $SCHEME://$SERVIP:$PORT$PATH -- $ERR です。

[ログ失敗メッセージ(Log Failure Msg)]

再同期の試行が失敗した後に発行される syslog メッセージ。

デフォルト値は $PN $MAC -- Resync failed: $ERR です。

[ユーザ設定可能再同期(User Configurable Resync)]

ユーザが IP 電話画面から電話機を再同期できるようにします。

デフォルト値は [はい(Yes)] です。

ファームウェア アップグレード パラメータ

次の表で、[プロビジョニング(Provisioning)] タブの [ファームウェア アップグレード(Firmware Upgrade)] セクションの各パラメータの機能と使用方法を定義します。

パラメータ名

説明とデフォルト値

[アップグレードの有効化(Upgrade Enable)]

再同期操作とは関係なく、ファームウェア アップグレード操作を有効にします。

デフォルト値は [はい(Yes)] です。

[アップグレードエラー再試行遅延(Upgrade Error Retry Delay)]

アップグレードが失敗した場合のアップグレードの再試行間隔(秒単位)。 デバイスには、ファームウェア アップグレードが失敗した後にアクティブになるファームウェア アップグレード エラー タイマーがあります。 タイマーは、このパラメータの値で初期化されます。 このタイマーが 0 までカウント ダウンすると、次のファームウェア アップグレードが試行されます。

デフォルト値は 3600 秒です。

アップグレード ルール

アップグレード条件と関連のファームウェア URL を定義するファームウェア アップグレード スクリプト。 プロファイル ルールと同じシンタックスが使用されます。

次の形式を使用してアップグレード ルールを入力します。

<tftp|http|https>://<ip address><:port>/<path>/<load name>

次に例を示します。

tftp://192.168.1.5/firmware/sip7832.11-0-1MPP-321.loads
tftp://192.168.1.5/firmware/sip8832.11-2-3MPP-321.loads

プロトコルが指定されない場合、TFTP が選択されます。 サーバー名を指定しない場合、URL をリクエストするホストがサーバー名として使用されます。ポートが指定されていない場合、デフォルトポートが使用されます(TFTP の場合は 69、HTTP の場合は 80、HTTPS の場合は 443)。

デフォルト値は空です。

[ログアップグレード要求メッセージ(Log Upgrade Request Msg)]

ファームウェア アップグレード試行の開始時に発行される Syslog メッセージ。

デフォルト値は $PN $MAC -- Requesting upgrade $SCHEME://$SERVIP:$PORT$PATH です。

[ログアップグレード成功メッセージ(Log Upgrade Success Msg)]

ファームウェア アップグレード試行が正常に完了した後に発行される syslog メッセージ。

デフォルト値は $PN $MAC -- Successful upgrade $SCHEME://$SERVIP:$PORT$PATH -- $ERR です。

[ログアップグレード失敗メッセージ(Log Upgrade Failure Msg)]

失敗したファームウェア アップグレード試行の後に発行される syslog メッセージ。

デフォルト値は $PN $MAC -- Upgrade failed: $ERR です。

ピア ファームウェア共有(Peer Firmware Sharing)

ピア ファームウェア共有機能を有効または無効にします。 機能を有効または無効にするには、はい あるいは いいえ を選択します。

デフォルト:はい(Yes)

ピア ファームウェア共有ログ サーバ(Peer Firmware Sharing Log Server)

UDP メッセージの送信先の IP アドレスとポートを示します。

例:10.98.76.123:514 の場合、10.98.76.123 が IP アドレス、514 がポート番号です。

汎用パラメータ

次の表で、[プロビジョニング(Provisioning)] タブの [汎用パラメータ(General Purpose Parameters)] セクションの各パラメータの機能と使用方法を定義します。

パラメータ名

説明とデフォルト値

GPP A ~ GPP P

汎用パラメータ GPP_ * は、電話機を特定のプロビジョニング サーバ ソリューションと連携するよう構成するときに自由文字列レジスタとして使用されます。 これらのパラメータには、次を含むさまざまな値を含むよう設定できます。
  • 暗号キー。

  • URL

  • マルチステージ プロビジョニング ステータス情報。

  • Post 要求テンプレート。

  • パラメータ名エイリアス マップ。

  • 最終的に完全なパラメータ値に組み込まれる部分文字列値

デフォルト値は空です。

マクロ展開変数

特定のマクロ変数は、次のプロビジョニング パラメータ内で認識されます。

  • Profile_Rule

  • Profile_Rule_*

  • Resync_Trigger_*

  • Upgrade_Rule

  • Log_*

  • GPP_*(特定の条件下で)

これらのパラメータ内では、$NAME や $(NAME) などのシンタックス タイプが認識され、展開されます。

マクロ変数の部分文字列は、表記 $(NAME:p) と $(NAME:p:q) で指定できます。この p と q は非負の整数です(リビジョン 2.0.11 以上で利用可能)。 結果のマクロ展開は、文字オフセット p から始まる長さ q(q が指定されない場合は文字列終端まで)の部分文字列です。 たとえば、GPP_A に ABCDEF が含まれている場合、$(A:2) は CDEF に展開され、$(A:2:3) は CDE に展開されます。

認識されない名前は変換されず、展開後のパラメータ値で $NAME または $(NAME) 形式は変更されません。

パラメータ名

説明とデフォルト値

$

$$ 形式は、単一の $ 文字に展開されます。

A ~ P

汎用パラメータ GPP_A ~ GPP_P の内容で置き換えられます。

SA ~ SD

特殊用途のパラメータ GPP_SA ~ GPP_SD で置き換えられます。 これらのパラメータには、プロビジョニングで使用されるキーまたはパスワードが保持されます。

(注)  

 

$SA ~ $SD は、オプションの resync URL 修飾子 --key を引数として認識されます。

MA

小文字の 16 進数を使用する MAC アドレス。000e08aabbcc など。

MAU

大文字の 16 進数を使用する MAC アドレス。000E08AABBCC など。

MAC

小文字の 16 進数と、16 進数のペアを区切るためにコロンを使用する MAC アドレス。 00:0e:08:aa:bb:cc など。

PN

PSN

SN

シリアル番号の文字列。88012BA01234 など。

CCERT

SSL クライアント証明書のステータス(インストール済みまたは未インストール)。

IP

ローカル サブネット内での電話機の IP アドレス。 たとえば、192.168.1.100 などです。

EXTIP

インターネットで表示される、電話機の外部 IP。 たとえば、66.43.16.52 などです。

SWVER

ソフトウェア バージョン文字列。 たとえば、

  • ファームウェアリリース 11.3 (1) SR1 (1) SR1 以前: sip 7832.11-0-1MPP-312

  • ファームウェアリリース 11.3 (2) 以降: sip 7832.11-3-2MPP 0001-609

  • ファームウェアリリース 11.3 (1) SR1 (1) SR1 以前: sip 8832.11-0-1MPP-312

  • ファームウェアリリース 11.3 (2) 以降: sip 8832.11-3-2MPP 0001-609

HWVER

PRVST

プロビジョニングの状態(数値文字列)

-1 = 明示的な再同期要求

0 = 電源投入再同期

1 = 定期的な再同期

2 = 再同期の失敗、再試行

UPGST

アップグレードの状態(数値文字列)

1 = 最初のアップグレード試行

2 = アップグレードの失敗、再試行

UPGERR

前回のアップグレード試行の結果メッセージ(ERR)。http_get failed など。

PRVTMR

最後の再同期から経過した秒数。

UPGTMR

最後のアップグレード試行から経過した秒数。

REGTMR1

SIP サーバで回線 1 が登録解除されてから経過した秒数。

REGTMR2

SIP サーバで回線 2 が登録解除されてから経過した秒数。

UPGCOND

レガシーのマクロ名。

SCHEME

再同期またはアップグレード URL の解析後に取得される TFTP、HTTP、または HTTPS のいずれかのファイル アクセス スキーム。

SERV

再同期またはアップグレード URL の解析後に取得される、要求ターゲット サーバのホスト名。

SERVIP

おそらく DNS ルックアップの後、再同期またはアップグレード URL の解析後に取得される、要求ターゲット サーバの IP アドレス。

PORT

再同期またはアップグレード URL の解析後に取得される、要求ターゲット UDP/TCP ポート。

PATH

再同期またはアップグレード URL の解析後に取得される、要求ターゲット ファイル パス。

ERR

再同期またはアップグレード試行の結果のメッセージ。 結果の syslog メッセージを生成するときにのみ役立ちます。 アップグレード試行の場合、UPGERR 変数の値は保持されます。

UIDn

回線 n の UserID 設定パラメータの内容。

ORIGTYPE

AUTHSTATUS

ライセンスの要求が必要かどうかを制御します。

パラメータ
ORIGTYPE
値: orig_ent、orig_mpp、none
パラメータ
AUTHSTATUS
値: classic、wxc、none
変数の追加先:
  • プロファイルルールまたはアップグレードルールのマクロ展開と条件式

  • 移行承認ルールのマクロ展開

内部エラー コード

電話機では、特定のエラー条件におけるユニットの動作をより細かく制御する設定を容易にするために内部エラー コード(X00 ~ X99)の番号を定義します。

パラメータ名

説明とデフォルト値

X00

SIP 要求を送信するときのトランスポート層(または ICMP)エラー。

X20

応答の待機中に SIP 要求がタイム アウトする。

X40

一般的な SIP プロトコル エラー(たとえば、200 および ACK メッセージにおける SDP の受け入れられないコーデック、または ACK 待機中のタイム アウト)。

X60

特定のダイヤル プランに従って無効な着信番号。