Cisco SCMS SM LEGs ユーザ ガイド Release 3.1.6
SM の統合 ― 設定
SM の統合 ― 設定
発行日;2012/01/16 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 2MB) | フィードバック

目次

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 の設定方法と、コマンドライン ユーティリティ(CLU)の使用方法について説明します。


) このマニュアルが該当するのは、ネットワークで SM サーバを使用している場合のみです。Service Control Engine(SCE)ではなく SM に DHCP Lease Query LEG をインストールします。


DHCP Lease Query LEG の設定の概要

SCE 上の DHCP Lease Query LEG は、2 つの CLI( leaseq.cfg ([一般的な設定])および dhcp_pkg.cfg ([ダイナミック パッケージ アソシエーション])を使用して設定されます。これらのファイルは、 ~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 オプションから取得でき、サブスクライバ ID として割り当てられた IP アドレスを使用してフォールバックできます。このセクションには、次のパラメータが含まれます。

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 などのログイン チェーンの他のモジュールがこのデータを使用できます( を参照)。このデータは、複数の 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

2 つのオプションを連結してポリシー名を作成するとき、オプションの間で使用する区切り文字を定義します。任意の文字を使用できます。デフォルトの値は、「_」です。

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 コンソールで定義されたとおりに記述されなければいけません(たとえば、packageIdmonitorupVlinkId、または downVlinkId)。


log_all

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

このパラメータの設定値は、 true または false です。デフォルト値は、 false です。

log_default_assignment

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

このパラメータの設定値は、 true または false です。デフォルト値は、 false です。

mapping_table.<policy_name>

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

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


) policy_name は、大文字と小文字が区別されます。DHCP パケットにあるとおりに記述する必要があります。


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

label_options

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

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

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

label_keys

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

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

label_options_type

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

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

デフォルト値は、 binary です。

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

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

options_order_for_policy_name=43:102,43:101
 

サブタイプ 102 の Option 43 にパッケージ タイプ(gold、silver、または bronze)が含まれ、サブタイプ 101 の Option 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 の Option 43 に「gold」値が含まれ、サブタイプ 101 の Option 43 に「domain1」値が含まれている場合、SM のサブスクライバに対応付けられるパッケージ ID は 11 という値になります。

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

[Additional Data]
label_options=82:1
label_keys=PORT_ID
label_options_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_options_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 CLU は、DHCP Lease Query LEG の設定、ステータス、および統計情報を表示します。コマンド形式は、 p3leasequery <operation> です。

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

 

表9-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
>