Cisco Broadband Access Center for Cable アドミニストレータ ガイド
パラメータ辞書
パラメータ辞書
発行日;2012/02/04 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 2MB) | フィードバック

目次

パラメータ辞書

概要

デフォルト辞書の使用方法

カスタム辞書

パラメータ辞書の構文

サンプルのパラメータ辞書

ユーザ インターフェイスからのパラメータ辞書の管理

パラメータ辞書の追加

パラメータ辞書の表示

パラメータ辞書の削除

パラメータ辞書の置換

パラメータ辞書

この章では、CWMP に関する顧客宅内装置(CPE)の構成および管理のプロセスで使用されるパラメータ辞書について説明します。

この章は、次の項で構成されています。

「概要」

「デフォルト辞書の使用方法」

「カスタム辞書」

「パラメータ辞書の構文」

「ユーザ インターフェイスからのパラメータ辞書の管理」

概要

パラメータ辞書は、CWMP デバイスを構成するときに BAC が使用する有効なオブジェクトおよびパラメータが示された XML ファイルです。この辞書により、設定およびファームウェア ルール テンプレートで使用されるオブジェクトおよびパラメータが検証されます。

パラメータ辞書には、サポートされているオブジェクトおよびパラメータ(名前、タイプ、書き込み許可、および読み取り許可など)に関するメタデータが含まれています。各辞書は、ファイルに格納され、管理 API または管理者のユーザ インターフェイスを介して RDU に追加されます。

設定およびファームウェア ルール テンプレートには ParameterDictionary タグが含まれます。このタグは、特定のテンプレート内でパラメータを定義する辞書を示します。BAC は、テンプレートが参照する辞書を使用して、設定およびファームウェア ルール テンプレートを検証します。設定およびファームウェア ルール テンプレート内のパラメータ名と値はすべて、パラメータ辞書で参照されるパラメータとの互換性を持っている必要があります。

図7-1 は、パラメータ辞書のスキーマを示しています。

図7-1 パラメータ辞書スキーマ

 


) 設定またはファームウェア ルール テンプレートにエラーが存在すると、命令の生成中にそのテンプレート処理が失敗します。構成命令の生成エラーを回避するため、次の事項をすべて確認してください。

オブジェクト名とパラメータ名が辞書に存在している。

テンプレートで直接指定された、または代入可能なパラメータを介して指定されたパラメータ値が、辞書で指定されたタイプになっている。

書き込み可能でないパラメータに、値が設定されていない。ただし、設定テンプレートに通知属性またはアクセス コントロール属性(あるいは両方)を設定することはできます。


 

デフォルト辞書の使用方法

この BAC リリースのデフォルト辞書は、TR-069、TR-098、および TR-104 仕様で定義されたパラメータに従っています。各仕様は、次のデータ モデルに対応しています。

TR-069:インターネット ゲートウェイ デバイス データ モデル 1.0

TR-098:インターネット ゲートウェイ デバイス データ モデル 1.1(豊富な QoS 機能を含む)

TR-104:ゲートウェイまたはスタンドアロン ATA 用の VoIP データ モデル

管理しやすくなるよう、 basic.cwmp.dict 辞書には、すべての標準パラメータ(TR-098 および TR-104)の組み合せが含まれています。

これらのデフォルト辞書は次の場所にあります。

BPR_HOME/rdu/templates/cwmp/tr069-cwmp-dictionary.xml

BPR_HOME/rdu/templates/cwmp/tr104-cwmp-dictionary.xml

BPR_HOME/rdu/templates/cwmp/tr098-cwmp-dictionary.xml

BPR_HOME/rdu/templates/cwmp/basic-cwmp-dictionary.xml


) BAC ではデフォルト辞書を変更または削除することはできません。


テンプレートが参照する新しいユーザ定義の辞書を追加できます。この機能を使用すると、ベンダー固有のパラメータを含む CPE パラメータ モデルを BAC でサポートできるようになります。詳細については、次のカスタム辞書の項を参照してください。BAC では、ベンダー固有の辞書のサポートにより、WT-135(IPTV STB)や WT-140(NAS)などの先端のデータ モデルをすべて使用できます。

カスタム辞書

CWMP には、標準のパラメータに加えてベンダー固有のパラメータを使用できる、拡張性のあるメカニズムが含まれています。そのため、BAC システムにカスタム辞書を追加して、任意の CPE をサポートすることができます。この機能を使用すると、実質的にどのようなデータ モデルを持つデバイスでもサポートできます。このようなデータ モデルには、WT-135(IPTV STB)や WT-140(NAS)などの先端の標準データ モデルがあります。

BAC に対するカスタム辞書の追加、表示、置換、または削除は、管理者のユーザ インターフェイスまたは管理 API から行うことができます。


) カスタム辞書は、設定テンプレートには使用できません。BAC 設定テンプレートで使用できるのは、BAC データベースに含まれているパラメータ辞書だけです。

カスタム辞書を追加する場合は、以前の項で説明したように、この辞書がパラメータ辞書スキーマに基づいていることを確認してください。


パラメータ辞書の構文

BAC は、パラメータ辞書スキーマに従って、パラメータ辞書の構文を検証します。このスキーマは、 BPR_HOME/rdu/templates/cwmp/TemplateDictionarySchema.xsd にあります。

標準オブジェクトにベンダー固有のパラメータを追加する場合は、必ず、それより高いレベルの標準オブジェクトとそのパラメータすべてをカスタム辞書で定義してください。

BAC では、TR-069 仕様で定義されたデータ タイプがすべてサポートされます。パラメータ辞書は、この BAC リリースでサポートされるデータ タイプを指定します。 表7-1 を参照してください。

 

表7-1 BAC でサポートされるデータ タイプ

タイプ
説明

String

許容最大長を示すには、 string (N) 構文を使用します。 (N) は、文字列の最大長です。

int

-2,147,483,648 ~ +2,147,483,647 の範囲の整数(上限と下限も含む)。

値の範囲を指定するには、 int[Min:Max] 構文を使用します。Min と Max の値も範囲に含まれます。Min または Max が省略されている場合は、制限がないことを示します。

unsignedInt

0 ~ 4,294,967,295 の範囲の符号なし整数(上限と下限も含む)。

値の範囲を指定するには、 unsignedInt[Min:Max] 構文を使用します。Min と Max の値も範囲に含まれます。Min または Max が省略されている場合は、制限がないことを示します。

boolean

1 つの値。1 は true を、0 は false を表します。

dateTime

UTC(Universal Coordinated Time; 万国標準時)で表される時刻(別に指定した場合を除く)。たとえば、 2004-01-03T03:04:05-(or +)05:00 と表されます。

base64

許容最大長を指定するには、 base 64 (N) 構文を使用します。 (N) は、Base64 符号化の後の最大文字数です。

サンプルのパラメータ辞書

次のサンプルは、TR-069 パラメータ リストとそれに対応する辞書スキーマを示しています。

 

名前
タイプ
書き込み
読み取り

InternetGatewayDevice

Object

-

R

InternetGatewayDevice.DeviceInfo

Object

-

R

X_HGI_ALG

Object

-

R

X_08017_ChipModel

string

-

R

ALGNumberOfEntries

unsignedInt

-

R

Manufacturer

string(64)

-

R

<ParameterDictionary xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="TemplateDictionarySchema.xsd">
<Object name="InternetGatewayDevice">
<Object name="DeviceInfo">
<Writable>false</Writable>
<Parameter>
<Name>Manufacturer</Name>
<Type>string(64)</Type>
<Readable>true</Readable>
<Writable>false</Writable>
</Parameter>
<Parameter>
<Name>X_08017_ChipModel</Name>
<Type>string</Type>
<Readable>true</Readable>
<Writable>false</Writable>
</Parameter>
</Object>
- <!-- custom property: InternetGatewayDevice.X_HGI_ALG -->
- <!-- as defined for HGI's Application Layer Gateway Management -->
- <Object name="X_HGI_ALG">
<Parameter>
<Name>ALGNumberOfEntries</Name>
<Type>unsignedint</Type>
<Readable>true</Readable>
<Writable>false</Writable>
</Parameter>
</Object>
</Object>
</ParameterDictionary>

ユーザ インターフェイスからのパラメータ辞書の管理

管理者のユーザ インターフェイスを使用すると、パラメータ辞書ファイルの管理や、パラメータ辞書の表示、追加、削除、または置換を行うことができます。ファイルをエクスポートするには、「ファイルのエクスポート」を参照してください。


) デフォルト辞書を変更または削除することはできません。


パラメータ辞書の追加

BAC RDU データベースに新しいパラメータ辞書を追加するには、次の手順に従います。


ステップ 1 プライマリ ナビゲーション バーの Configuration を選択します。

ステップ 2 セカンダリ ナビゲーション バーの Files を選択します。View Files ページが表示されます。

ステップ 3 Add をクリックします。

ステップ 4 Add Files ページが表示されます。File Type ドロップダウン リストから Parameter Dictionary を選択します。

ステップ 5 Source File Name と File Name に適切な情報を入力します。


) ソースファイルの正確な名前が分からない場合は、Browse 機能を使用して目的のディレクトリまで移動し、そのファイルを選択します。


ステップ 6 Submit をクリックします。

新しいファイルが追加された状態で View Files ページが表示されます。


 

パラメータ辞書の表示

BAC RDU データベースに含まれているファイルの内容を表示するには、次の手順に従います。


ステップ 1 プライマリ ナビゲーション バーの Configuration を選択します。

ステップ 2 セカンダリ ナビゲーション バーの Files を選択します。

ステップ 3 View Files ページが表示されます。File Type ドロップダウン リストから Parameter Dictionary を選択します。

ステップ 4 検索対象に指定したファイルに対応する View Details アイコン( )をクリックします。

パラメータ辞書の内容が表示されます。


 

パラメータ辞書の削除

RDU データベースから既存のパラメータ辞書を削除するには、次の手順に従います。


) 組み込みのデフォルト辞書は削除できません。



ステップ 1 Configuration > Files の順に選択します。

ステップ 2 File Type ドロップダウン リストから Parameter Dictionary を選択します。

ステップ 3 削除するファイルをクリックします。

ステップ 4 Delete をクリックします。

削除したファイルが含まれていない状態で View Files ページが表示されます。


 

パラメータ辞書の置換

BAC RDU データベースに含まれている既存のパラメータ辞書の内容を置換するには、次の手順に従います。


) 組み込みのデフォルト辞書は変更できません。



ステップ 1 Configuration > Files の順に選択します。

ステップ 2 File Type ドロップダウン リストから Parameter Dictionary を選択します。

ステップ 3 検索結果で、置換するファイルに対応するリンクをクリックします。

ステップ 4 Replace File ページが表示されます。選択したファイル名がすでにこのページに表示されています。表示されているファイルと置換するソース ファイルのパスを入力します。ソースファイルの正確な名前や場所が分からない場合は、 Browse 機能を使用して適切なディレクトリまで移動し、そのファイルを選択します。

ステップ 5 Submit をクリックします。置換ファイルを決定した後に確認ページが表示されて、置換後、影響を受けるデバイス用の命令が BAC によって再生成されることが示されます。

ステップ 6 OK をクリックします。

View Files ページが表示されます。