構成パラメータの概要
この章では、設定プロファイルのスクリプトで使用できるプロビジョニング パラメータについて説明します。
この製品のドキュメントセットは、偏向のない言語を使用するように配慮されています。このドキュメントセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブ ランゲージの取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
この章では、設定プロファイルのスクリプトで使用できるプロビジョニング パラメータについて説明します。
次の表で、[プロビジョニング(Provisioning)] タブの [設定プロファイルパラメータ(Configuration Profile Parameters)] セクションの各パラメータの機能と使用方法を定義します。
パラメータ名 |
説明とデフォルト値 |
---|---|
Provision_Enable |
ファームウェア アップグレード操作とは関係なくすべての再同期操作を制御します。 リモート プロビジョニングを有効にするには [はい] を設定します。 デフォルト値は [はい(Yes)] です。 |
リセット時に再同期 |
パラメータの更新やファームウェア アップグレードによるリブートを除き、リブートのたびに再同期がトリガーされます。 デフォルト値は [はい(Yes)] です。 |
再同期ランダム遅延 |
多数のデバイスの電源が同時に投入され、初期設定が試行された場合のプロビジョニング サーバーの過負荷状態を回避します。 この遅延は、デバイスの電源投入時またはリセット後の最初の設定試行時にのみ有効になります。 このパラメータは、プロビジョニングサーバーに接続する前にデバイスが待機する最大時間間隔です。 実際の遅延は、ゼロとこの値の間の疑似乱数です。 このパラメータは 20 秒単位で、デフォルト値の 3 は 60 秒を表します。 このパラメータを 0 に設定すると、この機能は無効になります。 デフォルト値は 2 (40 秒) です。 |
再同期時刻 |
デバイスがプロビジョニング サーバーと再同期する時間と分 (HHmm)。 デフォルト値は空です。 値が無効な場合、パラメータは無視されます。 このパラメータに有効な値が設定されている場合、Resync_Periodic パラメータは無視されます。 |
Resync_At_Random_Delay |
多数のデバイスの電源が同時に起動するときの、プロビジョニング サーバーの過負荷状態を回避できます。 複数の電話機からサーバーへの再同期要求が殺到するのを避けるため、電話機は時間と分、および時間と分にランダム遅延を加えた値 (hhmm、hhmm+random_delay) の範囲内で再同期します。 たとえば、ランダム遅延 =(Resync_At_Random_Delay + 30)/60 分とします。 秒単位で入力すると分に変換され、最終的な random_delay の間隔を計算するため、繰り上げて次の分単位に丸められます。 このパラメータを 0 に設定すると、この機能は無効になります。 デフォルト値は 600 秒(10 分)です。 パラメータ値が 600 より小さい値に設定されている場合、デフォルト値が使用されます。 |
Resync_Periodic |
プロビジョニング サーバーでの定期的な再同期の時間間隔。 サーバーで同期が最初に成功した後にのみ関連付けられている再同期タイマーがアクティブになります。 定期的な再同期を無効にするには、このパラメータを 0 に設定します。 デフォルト値は 3600 秒です。 |
Resync_Error_Retry_Delay |
再同期が失敗した場合に適用される再同期再試行間隔 (秒単位)。 デバイスには、プロビジョニング サーバーとの以前の同期の試行が失敗した場合にアクティブになるエラー再試行タイマーがあります。 デバイスは、タイマーがゼロになるまでサーバーに再度接続するのを待機します。 このパラメータは、エラー再試行タイマーに最初にロードされる値です。 このパラメータを 0 に設定すると、デバイスは失敗した試行後にプロビジョニング サーバーとの再同期を試行しません。 デフォルト値は 3600 秒です。 |
強制再同期遅延 |
ATA が再同期を実行する前に待機する最大遅延 (秒単位)。 電話回線のいずれかがアクティブな間、デバイスは再同期しません。 再同期には数秒かかる場合があるため、再同期を行う前に、デバイスが一定時間アイドル状態になるまで待つことをお勧めします。 これにより、ユーザーは中断することなく通話できます。 デバイスには、すべての回線がアイドル状態になったときにカウント ダウンを開始するタイマーがあります。 このパラメータは、カウンタの初期値です。 再同期イベントは、このカウンタが 0 になるまで遅延します。 デフォルト値は 14,400 秒です。 |
SIP からの再同期 |
SIP NOTIFY メッセージを介して再同期をトリガーできます。 デフォルト値は [はい(Yes)] です。 |
Resync_After_Upgrade_Attempt |
ファームウェアアップグレードが試行されるたびに再同期をトリガーします。 デフォルト値は [はい(Yes)] です。 |
再同期トリガー 1、再同期トリガー 2 |
設定可能な再同期トリガー条件。 これらのパラメータの論理式が TRUE に評価されたときに再同期がトリガーされます。 デフォルト値は(空)です。 |
Resync_Fails_On_FNF |
プロビジョニングサーバーからのファイルが見つからない応答が成功したか再同期に失敗したかを確認します。 再同期が失敗すると、エラー再同期タイマーがアクティブになります。 デフォルト値は [はい(Yes)] です。 |
HTTPS_Name_Validate |
HTTPS プロビジョニングのサブジェクト別名 (SAN) をチェックするかどうかを決定します。 SAN チェックを有効にするには、yes に設定します。 デフォルト値は [はい(Yes)] です。 |
Profile_Rule |
このパラメータは、プロビジョニング再同期コマンドに評価されるプロファイルスクリプトです。 このコマンドは、プロトコル (TFTP、HTTP、または HTTPS) と関連する URL を指定します。 コマンドが指定されていない場合、TFTP が想定され、TFTP サーバーのアドレスは DHCP オプション 66 を介して取得されます。 URL では、サーバーの IP アドレスまたは FQDN のいずれかを指定できます。 ファイル名には、デバイスの MAC アドレスに展開される $MA などのマクロを含めることができます。 デフォルト値は /ata$PSN.cfg です。 |
プロファイルルール B、プロファイルルール C、プロファイルルール D |
2 番目、3 番目、4 番目の再同期コマンドと、関連付けられたプロファイル URL を定義します。 これらのプロファイルスクリプトは、プライマリ プロファイル ルールの再同期操作が完了した後に順番に実行されます。 再同期がトリガーされ、プロファイル ルールが空白の場合でも、プロファイル ルール B、C、および D は評価され、実行されます。 デフォルト値は(空)です。 |
Log_Resync_Request_Msg |
このパラメータには、再同期の試行開始時に syslog サーバーに送信されるメッセージが含まれます。 デフォルト値は $PN $MAC –再同期の要求 $SCHEME://$SERVIP:$PORT$PATH です。 |
Log_Resync_Success_Msg |
再同期の試行が正常に完了した時点で発行される syslog メッセージ。 デフォルト値は $PN $MAC – 再同期が成功しました $SCHEME://$SERVIP:$PORT$PATH -- $ERR です。 |
Log_Resync_Failure_Msg |
再同期の試行が失敗した後に発行される syslog メッセージ。 デフォルト値は $PN $MAC – Resyncfailed: $ERR です。 |
レポートルール |
設定レポートが送信されるターゲット URL。 このパラメータは、Profile_Rule パラメータと同じ構文を使用し、関連付けられた URL を使用して TCP/IP コマンドに解決されます。 認証された SIP NOTIFY メッセージに応答して、次のイベントによって設定レポートが生成されます。 レポートは、すべてのデバイスパラメータの名前と値を含む XML ファイルです。 このパラメータには、必要に応じて、暗号キーを含めることができます。 例えば: [ --key $K ] tftp://ps.callhome.net/$MA/rep.xml.enc |
次の表で、[プロビジョニング(Provisioning)] タブの [ファームウェア アップグレード(Firmware Upgrade)] セクションの各パラメータの機能と使用方法を定義します。
パラメータ名 |
説明とデフォルト値 |
---|---|
アップグレードを有効にする |
再同期操作とは関係なく、ファームウェア アップグレード操作を有効にします。 デフォルト値は [はい(Yes)] です。 |
Upgrade_Error_Retry_Delay |
アップグレードが失敗した場合のアップグレードの再試行間隔(秒単位)。 デバイスには、ファームウェア アップグレードが失敗した後にアクティブになるファームウェア アップグレード エラー タイマーがあります。 タイマーは、このパラメータの値で初期化されます。 このタイマーが 0 までカウント ダウンすると、次のファームウェア アップグレードが試行されます。 デフォルト値は 3600 秒です。 |
Downgrade_Rev_Limit |
ファームウェアのアップグレードまたはダウングレード時に、許容可能なバージョン番号の下限値を適用します。 ファームウェア バージョンがこのパラメータ以上でない限り、デバイスはファームウェア アップグレード操作を完了しません。 デフォルト値は(空)です。 |
Upgrade_Rule |
このパラメータは、 Profile_Rule と同じ構文をもつ、ファームウェア アップグレードのスクリプトです。 アップグレードの条件と、関連するファームウェアの URL を定義します。 デフォルト値は(空)です。 |
Log_Upgrade_Request_Msg |
ファームウェアのアップグレード試行の開始時に発行される syslog メッセージ。 デフォルト値は $PN $MAC – アップグレードの要求 $SCHEME://$SERVIP:$PORT$PATH です。 |
Log_Upgrade_Success_Msg |
ファームウェアのアップグレードの試行が正常に完了した後に発行される syslog メッセージ。 デフォルト値は $PN $MAC – アップグレード成功 $SCHEME://$SERVIP:$PORT$PATH --$ERR です。 |
Log_Upgrade_Failure_Msg |
ファームウェアのアップグレード試行が失敗した後に発行される syslog メッセージ。 デフォルト値は $PN $MAC – アップグレードに失敗しました: $ERR です。 |
次の表で、[プロビジョニング(Provisioning)] タブの [汎用パラメータ(General Purpose Parameters)] セクションの各パラメータの機能と使用方法を定義します。
パラメータ名 |
説明とデフォルト値 |
---|---|
GPP_SA、GPP_SB、GPP_SC、GPP_SD |
暗号化キーとパスワードを保持するために設計された特別な目的のプロビジョニング パラメータ。 暗号化メカニズムの整合性を確保するには、これらのパラメータを秘密に保つ必要があります。 したがって、これらのパラメータはデバイス構成 Web ページには表示されず、SIP NOTIFY コマンドに応答して送信される構成レポートにも含まれません。 デフォルト値は(空)です。 |
GPP_A から GPP_P |
汎用プロビジョニング パラメータ。 これらのパラメータは、プロビジョニングおよびアップグレード ルールの変数として使用できます。 これらは、変数名の先頭に「$」文字を付けて参照されます (GPP_A の場合は $A)。 デフォルト値は(空)です。 |
特定のマクロ変数は、次のプロビジョニング パラメータ内で認識されます。
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 で置き換えられます。 これらのパラメータには、プロビジョニングで使用されるキーまたはパスワードが保持されます。
|
||
MA |
小文字の 16 進数を使用する MAC アドレス。000e08aabbcc など。 |
||
MAU |
大文字の 16 進数を使用する MAC アドレス。000E08AABBCC など。 |
||
MAC |
小文字の 16 進数と、16 進数のペアを区切るためにコロンを使用する MAC アドレス。 00:0e:08:aa:bb:cc など。 |
||
PN |
製品名。ATA191-MPP など。 |
||
PSN |
製品シリアル番号。 191 など。 |
||
SN |
シリアル番号の文字列。88012BA01234 など。 |
||
CCERT |
SSL クライアント証明書のステータス(インストール済みまたは未インストール)。 |
||
IP |
ローカル サブネット内での電話機の IP アドレス。 たとえば、192.168.1.100 などです。 |
||
EXTIP |
インターネットで表示される、電話機の外部 IP。 たとえば、66.43.16.52 などです。 |
||
SWVER |
ソフトウェア バージョン文字列。 たとえば、 ソフトウェア バージョン文字列。 11-1-0MPP-19 など。 |
||
HWVER |
ハードウェアのバージョン文字列 4 など。 |
||
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 |
ライセンスの要求が必要かどうかを制御します。 値: orig_ent、orig_mpp、none 値: classic、wxc、none
|
ATA は、特定のエラー条件下でのユニットの動作をより細かく制御できるように構成を容易にするために、いくつかの内部エラー コード (X00 ~ X99) を定義しています。
パラメータ名 |
説明とデフォルト値 |
---|---|
X00 |
SIP 要求を送信するときのトランスポート層(または ICMP)エラー。 |
X20 |
応答の待機中に SIP 要求がタイム アウトする。 |
X40 |
一般的な SIP プロトコル エラー(たとえば、200 および ACK メッセージにおける SDP の受け入れられないコーデック、または ACK 待機中のタイム アウト)。 |
X60 |
特定のダイヤル プランに従って無効な着信番号。 |