Cisco SCMS SM DHCP Lease Query LEG リファレンス ガイド
SM との統合 — 設定
SM との統合 -- 設定
発行日;2012/02/01 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 477KB) | フィードバック

目次

SM との統合 -- 設定

DHCP Lease Query LEG の設定

DHCP Lease Query LEG の設定

ポリシー アソシエーションの設定

ポリシー情報のダイナミックな割り当て

ポリシー情報のダイナミックな割り当ての例

ポリシー情報のスタティックな割り当て

DHCP Lease Query LEG CLU

DHCP Lease Query LEG のステータスの表示

DHCP Lease Query LEG の統計情報の表示

DHCP Lease Query LEG のバージョンの表示

SM との統合 -- 設定

ここでは、Subscriber Manager(SM)上での DHCP Lease Query LEG の設定方法と、Command-Line Utility(CLU; コマンドライン ユーティリティ)の使用方法について説明します。


) ネットワーク上で SM サーバを使用している場合には、この章を参照してください。SCE デバイスではなく SM サーバ上に DHCP Lease Query LEG をインストールする必要があります。


DHCP Lease Query LEG の設定

SM 上の DHCP Lease Query LEG は、 leaseq.cfg (全般的な設定)と dhcp_pkg.cfg (ダイナミック パッケージ アソシエーション)という 2 つのコンフィギュレーション ファイルを使用して設定されます。これらのファイルは ~pcube/sm/server/root/config ディレクトリにあります。

コンフィギュレーション ファイルは、角カッコで囲まれたセクション タイトル( [DHCP-Lease-Query-LEG] など)で始まる一連のセクションで構成されています。各セクションは、 parameter=value という形式のいくつかのパラメータで構成されています。番号記号(#)で始まる行は、注釈行です。

「DHCP Lease Query LEG の設定」

「ポリシー アソシエーションの設定」

「DHCP Lease Query LEG CLU」

DHCP Lease Query LEG の設定

ここでは、 leaseq.cfg の設定変数について説明します。

[DHCP-Lease-Query-LEG] セクションには、次のパラメータがあります。

start

SM が起動時に DHCP Lease Query LEG を実行するかどうかを定義します。

このパラメータに指定できる値は yes no です。デフォルト値は no です。

LEG を実行するには、このパラメータを yes に設定する必要があります。

max_concurrent_sessions

LEG が同時にサポートするセッション数を定義します。このパラメータにより、このモジュールが使用するリソースを制限します。

このパラメータに指定できる値は整数です。デフォルト値は 256 です。

dhcp_servers

LEG が要求を送信できる DHCP サーバを定義します。

DHCP サーバの IP アドレスまたはホスト名をカンマで区切って入力します。

server_port

DHCP サーバが待ち受けて、Lease Query メッセージが送信される UDP ポートを定義します。DHCP Forwarder と併用する場合は、9067 を使用することを推奨します。デフォルト値は 9067 です。

listening_port

LEG が待ち受けて、Lease Query 応答が送信される UDP ポートを定義します。DHCP Forwarder と併用する場合は、9068 を使用することを推奨します。デフォルト値は 9068 です。

client_port

LEG が DHCP サーバに Lease Query メッセージを送信するときに使用する UDP ポートを定義します。DHCP Forwarder と併用する場合は、8068 を使用することを推奨します。デフォルト値は 8068 です。

client_ip_address

DHCP サーバに送信される Lease Query パケットの送信元 IP アドレスを定義します。DHCP パケットの giaddr フィールドもこの IP アドレスを使用します。このパラメータは、複数のネットワーク インターフェイスを持つコンピュータで使用すると便利です。

デフォルト値は、コンピュータのループバック IP アドレスです。

support_auto_logout

自動ログアウト メカニズムでリース期限の満了を識別するたびに LEG が DHCP サーバに照会を行うかどうかを定義します。

このパラメータに指定できる値は true false です。デフォルト値は false です。

use_forwarder

LEG がローカル コンピュータ上の DHCP Forwarder アプリケーションを使用するかどうかを定義します。

このパラメータに指定できる値は true false です。デフォルト値は true です。

fail_over_criteria

要求が連続して失敗(タイムアウト)し、フェールオーバーをトリガーするまでの回数を定義します。サーバに障害が発生するとクエリーに応答でないため、これらのクエリーはタイムアウトします。連続的にクエリーがタイムアウトした回数がカウントされ、このしきい値に達したときに、第 2 のサーバがアクティブになります。デフォルト値は 3 です。


session_timeout パラメータは、障害の発生したサーバを検出する時間に影響します。設定された数のクエリーが失敗した場合のみフェールオーバー プロセスがトリガーされます。


log_timed_out_queries

タイムアウトしたクエリーに関するログ メッセージを制御します。

このパラメータに指定できる値は true または false です。デフォルト値は true です。

log_failed_queries

送信されなかったクエリーに関するログ メッセージを制御します。

このパラメータに指定できる値は true または false です。デフォルト値は true です。

log_all_queries

送信した各クエリーおよび受信した応答に関するログ メッセージを制御します。

このパラメータに指定できる値は true または false です。デフォルト値は false です。

このパラメータはトラブルシューティングにのみ使用してください。

log_login_failures

サブスクライバが SM にログインする結果にならなかった応答に関するログ メッセージを制御します。

このパラメータに指定できる値は true または false です。デフォルト値は true です。

[Subscriber ID] セクションは、LEG がサブスクライバ ID をどのように扱うかを定義します。サブスクライバ ID は、DHCP オプションから取得できます。フォールバックとして割り当てられた IP アドレスをサブスクライバ ID として使用することも可能です。このセクションには次のパラメータがあります。

dhcp_option

サブスクライバ ID として使用する DHCP オプションを定義します。このパラメータには、オプション番号を指定します。また、サブオプションのある DHCP オプションの場合には、DHCP オプションとサブオプション タイプをコロンで区切って指定します(43:123、61 など)。デフォルト値は 82:2(リモート ID 情報を使用したリレー エージェント情報)です。

dhcp_option_type

dhcp_option パラメータで定義された DHCP オプションのフォーマット タイプを定義します。

オプション値は、 binary (ASCII 16 進数ストリングに変換されたバイナリ ストリング)または string (ASCII ストリング)です。デフォルト値は binary です。

default_id

dhcp_option が DHCP パケットで検出されない場合に、LEG がフォールバックとして別の方法でサブスクライバ ID を定義するようにするかどうかを定義します。サポートされているフォールバックは次のとおりです。

ip ― 割り当てられた IP アドレスを使用して、IP_aaa.bbb.ccc.ddd のフォーマットでサブスクライバ ID を作成します。

このパラメータを設定しない場合 ― フォールバックはありません。ログインは実行されません。

デフォルトでは、このパラメータは設定されていません。

[DHCP-Lease-Query-Ids] セクションでは、Lease Query トランザクションのメッセージ タイプ別にメッセージ タイプ番号が定義されます。DHCP Lease Query 定義は IETF ドラフトであるため、これは必要です。このセクションには次のパラメータがあります。

lease_query

DHCPLEASEQUERY メッセージ タイプの値を定義します。デフォルト値は 13 です。

lease_active

DHCPLEASEACTIVE メッセージ タイプの値を定義します。デフォルト値は 16 です。

次に、コンフィギュレーション ファイルの例を示します。

[DHCP-Lease-Query-LEG]
start=yes
dhcp_servers = 198.1.2.3, 198.5.6.7
fail_over_criteria=10
session_timeout=10
log_timed_out_queries=true
log_failed_queries=true
log_all_queries=true
log_login_failures=true
[Subscriber ID]
dhcp_option=44
dhcp_option_type=binary
[DHCP-Lease-Query-Ids]
lease_query=13
lease_active=16

ポリシー アソシエーションの設定


) この項で説明する設定作業は省略可能です。


DHCP Lease Query LEG でのサブスクライバ ポリシーの設定は、次のいずれかの方法で処理することができます。

DHCP パケットから抽出した情報を使用して、ポリシー情報をダイナミックに割り当てる。「ポリシー情報のダイナミックな割り当て」を参照してください。

DHCP Lease Query LEG を介してログインする全てのサブスクライバに一定のパッケージ ID をスタティックに割り当てる。「ポリシー情報のスタティックな割り当て」を参照してください。

ポリシー情報のダイナミックな割り当て

DHCP パケットでポリシー情報が提供される場合、ポリシー情報をダイナミックに割り当てることができます。LEG は指定されたオプションを連結し、 ポリシー名 を作成します。この設定を使用して、 ポリシー名 とアプリケーション ポリシー パラメータ(パッケージ ID や仮想リンクなど)との間でのマッピングが可能です。DHCP Lease Query LEG では複数のポリシーをサポートできます。

DHCP パケットからポリシー情報を抽出するには、コンフィギュレーション ファイル dhcp_pkg.cfg で、ポリシー情報を含むオプション タイプと、 ポリシー名 から Service Control Application for Broadband(SCA BB)のパッケージ ID(またはその他のポリシー)への変換マップを定義します。

LEG は、LEG 設定に基づいてログイン動作にデータを追加することができます。このデータは、キーと値のペアとして追加されます。SOAP LEG など、ログイン チェーンの他のモジュールがこのデータを使用することができます(『 Cisco SCMS SM SOAP LEG Reference Guide 』を参照)。このデータは、複数の DHCP オプションのデータを連結することで作成され、ユーザ定義のラベルを指定することができます。

[DHCP.Policy.XXX] セクションには、次のパラメータがあります。

options_order_for_policy_name

ポリシー アソシエーション情報が含まれている DHCP オプションを定義し、データの連結順序を定義します。giaddr(リレー エージェント IP)と呼ばれる DHCP ヘッダ フィールドもサポートしていますが、 option_type パラメータでタイプとして integer を指定する必要があります。

このパラメータにはデフォルト値はありません。

フォーマットは option[:subtype],option[:subtype],giaddr です。

options_type

options_order_for_policy_name パラメータで定義された DHCP オプションとフィールドのフォーマット タイプを定義します。

このパラメータに指定できる値は、 binary (ASCII 16 進数ストリングに変換されたバイナリ ストリング)、 string (ASCII ストリング)、または integer (ドット付き表記の IP アドレス ストリングに変換された 4 バイトの整数)です。 options_order_for_policy_name と同じ順序でリストを指定します。

このパラメータにはデフォルト値はありません。

name_seperator_value

オプションを連結してパッケージ名を作成するとき、オプション間で使用する区切り文字を定義します。任意の文字を指定できます。デフォルト値は [_] です。

use_default

設定可能オプションの不足やオプションの未設定など、DHCP データからポリシー情報が抽出できない場合に、デフォルトのポリシーを使用するかどうかを決定します。

このパラメータに指定できる値は true または false です。デフォルト値は false です。

default_policy

DHCP データからポリシー情報を抽出できない場合に使用するデフォルトのポリシー ID を定義します。このパラメータが関係するのは、 use_default パラメータが true に設定されている場合だけです。

このパラメータに指定できる値は任意の整数値です。このパラメータにはデフォルト値はありません。

allow_login_with_no_policy

DHCP データからポリシー情報を抽出できず、かつ use_default パラメータが false に設定されている場合に、ポリシー情報なしでログインを実行するかどうかを定義します。

このパラメータが関係するのは、 use_default パラメータが false に設定されている場合だけです。

このパラメータに指定できる値は true または false です。デフォルト値は true です。

policy_property_name

ポリシー情報を含むアプリケーション プロパティ名を定義します。このパラメータにはデフォルト値はありません。


policy_property_name パラメータは大文字と小文字が区別されます。SCA BB コンソールで定義したとおりに記述されていなければなりません(packageIdmonitorupVlinkIddownVlinkId など)。


log_all

すべてのポリシー アソシエーション イベントに対して詳細なユーザログ メッセージを記述するかどうかを定義します。

このパラメータに指定できる値は true または false です。デフォルト値は false です。

log_default_assignment

デフォルト値( default_policy パラメータで定義)の割り当てすべてに対して、ユーザログ メッセージを記述するかどうかを定義します。

このパラメータに指定できる値は true または false です。デフォルト値は false です。

mapping_table.<policy_name>

DHCP パケット内のポリシー情報から、SCA BB アプリケーションで使用するポリシー プロパティ値に変換するための情報が含まれている複数のエントリです。

これらのエントリにはデフォルト値はありません。


) policy_name は大文字と小文字が区別されます。SCA BB コンソールで定義したとおりに記述されていなければなりません。


コンフィギュレーション ファイルの [Additional Data] セクションには、次のパラメータがあります。

label_options

ログイン動作で追加するために抽出する DHCP オプションを定義します。

指定できる値はオプション番号です。サブオプションのある DHCP オプションの場合は、オプションとサブオプションをコロンで区切って指定します(43:123、61 など)。

このパラメータにはデフォルト値はありません。

label_keys

label_options パラメータで定義された DHCP オプションをマーキングするキーを定義します。

このパラメータにはデフォルト値はありません。

label_options_type

label_option パラメータで定義された DHCP オプションのフォーマット タイプを定義します。

このパラメータに指定できる値は、 binary (ASCII 16 進数ストリングに変換されたバイナリ ストリング)または string (ASCII ストリング)です。

デフォルト値は binary です。

ポリシー情報のダイナミックな割り当ての例

DHCP パケットのオプション 43(Vendor Specific Option)でポリシー情報が提供され、サブタイプ 102 および 101 が両方とも使用されていると仮定します。 options_order_for_policy_name パラメータを次のように設定します。

options_order_for_policy_name=43:102,43:101
 

サブタイプ 102 のオプション 43 にパッケージ タイプ(gold、silver、または bronze)が含まれ、サブタイプ 101 のオプション 43 にドメイン情報が含まれていると仮定します(パッケージ タイプの意味はドメインごとに異なります)。区切り値がデフォルト値に設定されている場合、mapping_table エントリを次のように設定します。

mapping_table.gold_domain1=11
mapping_table.gold_domain2=12
mapping_table.silver_domain1=13
mapping_table.silver_domain2=14
 

この設定では、DHCP パケットでサブタイプ 102 のオプション 43 に [gold] という値が含まれ、サブタイプ 101 のオプション 43 に [domain1] という値が含まれる場合、SM でこのサブスクライバに対応付けられるパッケージ ID は、11 という値になります。

次に、追加データとしてリレー エージェント回線 ID オプションのデータをログイン動作に追加する設定を示します。

[Additional Data]
label_options=82:1
label_keys=PORT_ID
label_option_type=string
 

次に、コンフィギュレーション ファイル全体の例を示します。

[DHCP.Policy.Package]
options_order_for_policy_name=43:102,43:101
name_separator_value=_
use_default=true
default_policy=1
policy_property_name=packageId
allow_login_with_no_policy=false
log_all=false
log_default_assignment=false
mapping_table.gold_domain1=11
mapping_table.gold_domain2=12
mapping_table.silver_domain1=13
mapping_table.silver_domain2=14
[Additional Data]
label_options=82:1
label_keys=PORT_ID
label_option_type=string

ポリシー情報のスタティックな割り当て

インストールでパッケージ情報のダイナミックな割り当てが不要な場合には、次の例のように、コンフィギュレーション ファイル dhcp_pkg.cfg で、すべてのサブスクライバに割り当てられるデフォルトのパッケージ ID とデフォルトの仮想リンクを定義する必要があります。

[DHCP.Policy.Package]
policy_property_name=packageId
allow_login_with_no_policy=false
use_default=true
default_policy=1
[DHCP.Policy.VirtualLinkDownstream]
policy_property_name=downVlinkId
allow_login_with_no_policy=false
use_default=true
default_policy=0
[DHCP.Policy.VirtualLinkUpstream]
policy_property_name=upVlinkId
allow_login_with_no_policy=false
use_default=true
default_policy=0
 

その他のパラメータは、いずれも設定する必要はありません。

DHCP Lease Query LEG CLU

p3leasequery ユーティリティは、DHCP Lease Query LEG の設定、ステータス、および統計情報を表示します。コマンド フォーマットは、 p3leasequery <operation> です。

次の表に、p3leasequery の動作を示します。

 

表3-1 p3leasequery の動作

動作
説明
--show

DHCP Lease Query LEG の設定およびステータスをすべて表示します。

--show-statistics

処理された DHCP メッセージのカウンタおよび実行されたログイン動作の回数を表示します。

--show-version

DHCP Lease Query LEG のバージョン番号を表示します。

--help

使用可能な動作と引数、およびその簡単な説明を表示します。

「DHCP Lease Query LEG のステータスの表示」

「DHCP Lease Query LEG の統計情報の表示」

「DHCP Lease Query LEG のバージョンの表示」

DHCP Lease Query LEG のステータスの表示

次に、 p3leasequery CLU の show 動作を使用する例を示します。

>p3leasequery --show
DHCP Lease-Query LEG:
=====================
Active: true
DHCP Servers:
Active: 10.1.2.3
Standby: N/A
Session timeout: 20
Fail over criteria: 3
Subscriber ID:
Option: 82:2
Format: binary
Fallback: none
Command terminated successfully
>

DHCP Lease Query LEG の統計情報の表示

次に、 p3leasequery CLU の show-statistics 動作を使用する例を示します。

>p3leasequery --show-statistics
DHCP Lease-Query LEG Statistics:
================================
Lease-Queries Sent: 16
Lease-Queries Replied: 16
Active Lease Replies: 16
Non-Active Lease Replies: 0
Total timed-out sessions: 0
Consecutive timed-out sessions: 0
Number of fail-overs 0
Invalid Replies: 0
Sessions in process: 0
Max-Concurrent sessions: 3
Command terminated successfully
>

DHCP Lease Query LEG のバージョンの表示

次に、 p3leasequery CLU の show-version 動作を使用する例を示します。

>p3leasequery --show-version
DHCP LEASE QUERY LEG 3.1.0 Build 176
>