dhcpd-options(5) dhcpd-options(5) 名称 dhcp-options - 動的ホスト構成プロトコルのオプション 解説 動的ホスト構成プロトコル (DHCP: Dynamic Host Configuration Protocol) を 使用することにより、クライアントは DHCP サーバから、ネットワーク設定 や ネットワーク上で利用可能な様々なサービスについて記述している オプション を受け取ることができます。 dhcpd(8) や dhclient(8) を設定するときに、し ば しばオプションを宣言する必要があるでしょう。ここでは、オプションを宣 言する文法、そして宣言可能なオプションの名前と書式を文書化しています。 リファレンス: オプション文 DHCP option 文は、常にキーワード option で開始し、単一のオプション名 が 続 き、オプションデータが続きます。オプションの名前とデータの書式は後述 します。すべての DHCP オプションを網羅的に指定する必要はなく、クライ ア ントに必要なオプションのみを指定します。 オプションデータには、次のように様々な書式があります: ip-address データタイプは、明示的な IP アドレス (例えば 239.254.197.10) またはドメイン名 (例えば haagen.isc.org) のどちらでも指定可能です。ドメ イ ン名で指定する場合、そのドメイン名を解決すると単一の IP アドレスにな るようにしてください。 int32 データタイプは符号付き 32 ビット整数を指定します。 uint32 デー タ タイプは符号無し 32 ビット整数を指定します。 int16 および uint16 のデー タタイプは、符号付きおよび符号無しの 16 ビット整数を指定します 。 int8 お よび uint8 のデータタイプは、符号付きおよび符号無しの 8 ビット整数を 指定します。符号無し 8 ビット整数は、オクテットと呼ばれることもあります 。 text データタイプは NVT ASCII 文字列を指定します。文字列はダブルクォー トで括る必要があります。例えば root-path オプションを指定する文法は、次 のようになります。 option root-path "10.0.1.4:/var/tmp/rootfs"; domain-name データタイプはドメイン名を指定します。文字列をダブルクォー トで括っていけません。このデータタイプは、他の既存の DHCP オプション に は使われません。ドメイン名は、text オプションであるかのように保持されま す。 flag データタイプはブール値を指定します。ブール値は true また は false の いずれかです (もしくは、on または off の方が分かりやすければ、こちら でもかまいません)。 string データタイプは、ダブルクォートで括られる NVT ASCII 文字列か、 コ ロ ン区切りの 16 進数で指定されるオクテットの連続のいずれかを指定します 。例えば次のようになります: option dhcp-client-identifier "CLIENT-FOO"; もしくは option dhcp-client-identifier 43:4c:49:45:54:2d:46:4f:4f; 式を用いたオプション値の設定 クライアントが送出するいくつかの値を、DHCP オプションの値を設定するのに 使 え る と便利なことがあります。これをするには式の評価が利用できます。 dhcp-eval(5) マニュアルページに式の書き方が述べられています。評価の結果 をオプションに代入するには、オプションを次のように定義します: option my-option = expression ; 例えば次のようにします: option hostname = binary-to-ascii (16, 8, "-", substring (hardware, 1, 6)); 標準 DHCP オプション 次 に示す様々なオプションに関する記述は、 DHCP オプションに関する最新の IETF ドラフト文書からのものです。名前が掲載されていないオプションは、ま だ 実装されていないかもしれませんが、設定ファイルに定義することで、その ようなオプションを使えるかもしれません。詳しくは、この先の「新規オプ シ ョンの定義」から続く記述を参照してください。 ここに記述されているオプションのうちのいくつかは、DHCP サーバもしくはク ライアントによって自動的に生成されるもので、ユーザには設定できません 。 そ のようなオプションの値は、受信側の DHCP プロトコルエージェント (サー バもしくはクライアント) の設定ファイル中の、例えば条件式などで使われ ま す 。しかしこのオプションの値は、送信側のエージェントの設定ファイル中で は使われることはありません。というのも、その値は、設定ファイルが処理 さ れ た後に決定されるからです。以降の記述において、そのようなオプションに は「ユーザが設定することはできません」と記されます。 標準オプションを示します: option all-subnets-local flag; 本オプションは、クライアントが接続されている IP ネットワークの全サブ ネ ットが使用する MTU が、クライアントが直接接続されているサブネット の MTU と同じであると、クライアントが仮定してよいかを指定します。 値 true は、全サブネットは同一の MTU であることを意味します。値 false は、直接接続されているネットワークのサブネットには、より小さ な MTU を持つものがあると、クライアントが仮定すべきであることを意味します。 option arp-cache-timeout uint32; 本オプションは、ARP キャッシュエントリのタイムアウトを秒数で指定しま す。 option bootfile-name text; 本オプションは、起動ファイルを指定するために使用します。クライアント によってサポートされている場合、これは filename 宣言と同じ効果を持ち ま す。 BOOTP クライアントで、このオプションをサポートしているものは 少ないでしょう。 DHCP クライアントによってはサポートするものがあり、 実際必須としているものがあります。 option boot-size uint16; 本オプションは、クライアント用のデフォルトのブートイメージの長さを、 512 オクテットブロック数で指定します。 option broadcast-address ip-address; 本オプションは、クライアントのサブネットで使用されているブロードキャ ス トアドレスを指定します。正当なブロードキャストアドレスの値は、STD 3 (RFC1122) の 3.2.1.3 節に規定されています。 option cookie-servers ip-address [, ip-address... ]; クッキーサーバオプションは、クライアントが利用可能な RFC 865 クッ キ ーサーバのリストを指定します。サーバは、優先されるものから順にリスト してください。 option default-ip-ttl uint8; 本オプションは、クライアントがデータグラムを送出するときに使用すべき 、デフォルトの生存時間 (TTL) を指定します。 option default-tcp-ttl uint8; 本 オプションは、クライアントが TCP セグメントを送出するときに使用す べき、デフォルトの TTL を指定します。最小値は 1 です。 option dhcp-client-identifier string; 本オプションを使って、ホスト宣言中で DHCP クライアント識別子を指定す る こ とができます。このクライアント識別子で照合を行うことで、 dhcpd はそのホストのレコードを発見することができます。 DHCP クライアントの中には、ASCII テキストによってクライアント識別 子 が設定された場合、その ASCII テキストの先頭に 0 をつけるものがあるこ とに注意してください。その場合、 option dhcp-client-identifier "foo"; ではなく、以下のように記述する必要があるでしょう。 option dhcp-client-identifier "\0foo"; option dhcp-lease-time uint32; 本オプションは、クライアント要求 (DHCPDISCOVER また は DHCPREQUEST) の中で、クライアントが IP アドレスのリース時間を要求するために使用さ れます。またサーバ応答 (DHCPOFFER) の中で、DHCP サーバが提示したいリ ース時間を指定するのにも、このオプションは使われます。 本 オ プ シ ョンは、サーバではユーザが直接設定することはできません。 dhcpd.conf(5) の max-lease-time と default-lease-time サーバオプショ ンを参照してください。 option dhcp-max-message-size uint16; 本オプションは、クライアントから送出された場合、サーバがクライアント に送出するすべての応答の最大サイズを指定します。サーバで設定された場 合 、クライアントが dhcp-max-message-size オプションを送信してこなか った際に、このサーバで設定された値が使用されます。これは、BOOTP 応答 でも DHCP 応答と同様に動作します。 option dhcp-message text; 本オプションは、障害が起きた時に、DHCP サーバが DHCPNAK メッセージ中 で DHCP クライアントへエラーメッセージを提供するのに使用します。また ク ラ イ ア ントが、提示されたパラメータを拒否した理由を示すために、 DHCPDECLINE メッセージ中で本オプションを使うこともあります。 本オプションは、ユーザが設定することはできません。 option dhcp-message-type uint8; 本オプションは、クライアントとサーバの両者から送出され、 DHCP パケッ トが含んでいる DHCP メッセージのタイプを指定します。本オプションが取 り得る値は、以下のとおりです (RFC2132 よりそのまま抜粋)。 1 DHCPDISCOVER 2 DHCPOFFER 3 DHCPREQUEST 4 DHCPDECLINE 5 DHCPACK 6 DHCPNAK 7 DHCPRELEASE 8 DHCPINFORM 本オプションは、ユーザが設定することはできません。 option dhcp-option-overload uint8; 本オプションは、DHCP ’sname’ もしくは ’file’ フィールドが、 DHCP オ プションを保持するために詰め込み過ぎになっていることを示すのに使われ ます。 DHCP サーバは、返却されたパラメータが、オプションに通常割り当 てられた空間を超過した場合、本オプションを挿入します。 本オプションが存在した場合、クライアントは、標準のオプションフィール ドの解釈が終了した後、指定された付加フィールドの解釈を行います。 本オプションの正当な値は、以下の通りです: 1 ’file’ フィールドが、オプション保持に使用されてます 2 ’sname’ フィールドが、オプション保持に使用されてます 3 両方のフィールドが、オプション保持に使用されてます 本オプションは、ユーザが設定することはできません。 option dhcp-parameter-request-list uint16; 本オプションは、クライアントから送出された場合、サーバに返答を希望す るオプションをクライアントが指定します。通常 ISC DHCP クライアントで は、request 文を用いて行われます。本オプションがクライアントから指定 されなかった場合、通常 DHCP サーバは、スコープ内で有効かつ応答に収ま るすべてのオプションを返します。本オプションがサーバ上で指定された場 合、サーバはその指定されたオプションを返します。これは、クライアント が要求しなかったオプションを、クライアントに強制するのに使用されます 。また、通常サーバが返すオプションのセットをさらに制限する必要のある クライアントに対して、DHCP サーバの応答を調整するのにも使用されま す 。 option dhcp-rebinding-time uint32; 本 オプションは、クライアントがアドレスを取得してから REBINDING 状態 に移行するまでの時間を秒数で指定します。 本オプションは、ユーザが設定することはできません。 option dhcp-renewal-time uint32; 本オプションは、クライアントがアドレスを取得してから RENEWING 状態に 移行するまでの時間を秒数で指定します。 本オプションは、ユーザが設定することはできません。 option dhcp-requested-address ip-address; 本 オプションは、クライアントが、DHCPDISCOVER 内で特定の IP アドレス が割り当てられることを要求するのに使用されます。 本オプションは、ユーザが設定することはできません。 option dhcp-server-identifier ip-address; 本オプションは、DHCPOFFER と DHCPREQUEST メッセージ中で使用され、 ま た DHCPACK と DHCPNAK メッセージ中にも含まれることがあります。 DHCP サーバは、クライアントが (訳注: 複数サーバからの) リースの提示を区別 できるよう、DHCPOFFER に本オプションを含めます。 DHCP クライアントは 、DHCP サーバへユニキャストするすべての DHCP メッセージの宛先アド レ スとして ’server identifier’ フィールドの内容を使用します。また DHCP クライアントは、DHCPREQUEST メッセージ中に本オプションを含め、複数の リースの提示のどれを受け入れたかを示します。 本オプションの値は、サーバの IP アドレスです。 本オプションは、ユーザが直接設定することはできません。 dhcpd.conf(5) の server-identifier サーバオプションを参照してください。 option domain-name text; 本オプションは、ドメインネームシステムを使用してホスト名を解決すると きにクライアントが使用すべきドメイン名を指定します。 option domain-name-servers ip-address [, ip-address... ]; domain-name-servers オプションは、クライアントが利用可能なドメインネ ームシステム (STD 13, RFC 1035) のネームサーバのリストを指定します。 サーバは、優先されるものから順にリストしてください。 option extensions-path text; 本オプションは、追加オプションを含むファイルのファイル名を指定します 。この追加オプションは、RFC2132 で規定されている DHCP オプションの書 式に沿って解釈されます。 option finger-server ip-address [, ip-address... ]; Finger サーバオプションは、クライアントが利用可能な Finger のリスト を指定します。サーバは、優先されるものから順にリストしてください。 option font-servers ip-address [, ip-address... ]; 本オプションは、クライアントが利用可能な X Window System フォント サ ーバを指定します。サーバは、優先されるものから順にリストしてください 。 option host-name string; 本オプションは、クライアントの名前を指定します。この名前は、ローカル ドメイン名に修飾されていても、いなくてもかまいせん (ドメイン名を指定 するには、domain-name オプションの使用をお勧めします)。文字集合の 制 約については RFC 1035 を参照してください。クライアントマシンのホスト 名が設定されていない場合 (すなわち rc.conf(5) で空文字列に設定されて いる場合) のみ、 dhclient-script(8) が本オプションを尊重します。 option ieee802-3-encapsulation flag; 本オプションは、インタフェースがイーサネットである場合に、クライアン トがイーサネットバージョン 2 (RFC 894) と IEEE 802.3 (RFC 1042) のど ち らのカプセル化を使用すべきかを指定します。値 false は、クライアン トが RFC 894 のカプセル化を使用すべきであることを意味します。値 true は、クライアントが RFC 1042 のカプセル化を使用すべきであることを意味 します。 option ien116-name-servers ip-address [, ip-address... ]; ien116-name-servers オプションは、クライアントが利用可能な IEN 116 ネームサーバのリストを指定します。サーバは、優先されるものから順にリ ストしてください。 option impress-servers ip-address [, ip-address... ]; impress-server オプションは、クライアントが利用可能な Imagen Impress サーバのリストを指定します。サーバは、優先されるものから順にリストし てください。 option interface-mtu uint16; 本オプションは、このインタフェースに対して使用する MTU を指定しま す 。 MTU に対する最小の正当値は 68 です。 option ip-forwarding flag; 本オプションは、クライアントが、パケットを転送するように自分の IP 層 を設定すべきかを指定します。値 false は IP 転送を無効にすることを 意 味し、値 true は IP 転送を有効にすることを意味します。 option irc-server ip-address [, ip-address... ]; IRC サーバオプションは、クライアントが利用可能な IRC のリストを指定 します。サーバは、優先されるものから順にリストしてください。 option log-servers ip-address [, ip-address... ]; log-server オプションは、クライアントが利用可能な MIT-LCS UDP ログサ ーバのリストを指定します。サーバは、優先されるものから順にリストして ください。 option lpr-servers ip-address [, ip-address... ]; LPR サーバオプションは、クライアントが利用可能な RFC 1179 ラインプリ ンタサーバのリストを指定します。サーバは、優先されるものから順にリス トしてください。 option mask-supplier flag; 本オプションは、ICMP を使用したサブネットマスク要求に対して、クラ イ ア ントが応答すべきかを指定します。値 false は、クライアントが応答す べきでないことを意味します。値 true は、クライアントが応答すべきであ ることを意味します。 option max-dgram-reassembly uint16; 本オプションは、クライアントが再組み立ての準備をすべき最大データグラ ムサイズを指定します。最小の正当値は 576 です。 option merit-dump text; 本オプションは、クライアントがクラッシュするときのクライアントのコア イ メ ー ジ がダンプされるファイルのパス名を指定します。パスの書式は 、NVT ASCII 文字集合の文字からなる文字列です。 option mobile-ip-home-agent ip-address [, ip-address... ]; 本オプションは、クライアントが利用可能なモバイル IP ホームエージェン トの IP アドレスのリストを指定します。エージェントは、優先されるもの から順にリストしてください。ただし、通常エージェントは 1 つでしょ う 。 option nds-context string; nds-context オプションは、NDS クライアントのための最初の NetWare デ ィレクトリサービスの名前を指定します。 option nds-servers ip-address [, ip-address... ]; nds-servers オプションは、NDS サーバの IP アドレスのリストを指定しま す。 option nds-tree-name string; nds-tree-name オプションは、NDS クライアントが使用すべき NDS ツリー の名前を指定します。 option netbios-dd-server ip-address [, ip-address... ]; NetBIOS データグラム配布サーバ (NBDD) オプションは、 RFC 1001/1002 の NBDD サーバのリストを、優先されるものから順に指定します。 option netbios-name-servers ip-address [, ip-address...]; NetBIOS ネームサーバ (NBNS) オプションは、 RFC 1001/1002 の NBNS ネ ームサーバのリストを、優先されるものから順に指定します。 現 在 で は 、NetBIOS ネームサービスは WINS と呼ばれることの方が多いです。 net- bios-name-servers オプションを使用して、WINS サーバを指定可能です。 option netbios-node-type uint8; NetBIOS ノードタイプオプションは、設定可能な NetBIOS over TCP/IP ク ラ イアントを、 RFC 1001/1002 に記述されているように設定します。値は 単一のオクテットとして指定され、クライアントタイプを意味します。 使用可能なノードタイプは次の通りです: 1 B ノード: ブロードキャスト - WINS 無し 2 P ノード: ピア - WINS のみ 4 M ノード: ミックス - ブロードキャスト後に WINS 8 H ノード: ハイブリッド - WINS 後にブロードキャスト option netbios-scope string; NetBIOS スコープオプションは、RFC 1001/1002 に規定されているように、 ク ライアントの NetBIOS over TCP/IP スコープパラメータを指定します。 文字集合の制約については RFC1001, RFC1002, RFC1035 を参照してくだ さ い。 option nis-domain text; 本 オ プ シ ョンは、クライアントの NIS (Sun Network Information Ser- vices) ドメインを指定します。ドメインの書式は、NVT ASCII 文字集合 の 文字からなる文字列です。 option nis-servers ip-address [, ip-address... ]; 本 オプションは、クライアントが利用可能な NIS サーバを示す IP アドレ スのリストを指定します。サーバは、優先されるものから順にリストしてく ださい。 option nisplus-domain text; 本オプションは、クライアントの NIS+ ドメインの名前を指定します。ドメ インの書式は、NVT ASCII 文字集合の文字からなる文字列です。 option nisplus-servers ip-address [, ip-address... ]; 本オプションは、クライアントが利用可能な NIS+ サーバを示す IP アドレ スのリストを指定します。サーバは、優先されるものから順にリストしてく ださい。 option nntp-server ip-address [, ip-address... ]; NNTP サーバオプションは、クライアントが利用可能な NNTP のリストを 指 定します。サーバは、優先されるものから順にリストしてください。 option non-local-source-routing flag; 本オプションは、非ローカルな指定経路 (non-local source route) を持つ データグラムを転送するように、クライアントが自分の IP 層を設定すべき か を指定します (本項目については [4] の 3.3.5 節を参照してください) 。値 false はそのようなデータグラムの転送を許可しないことを意味し 、 値 true は転送許可を意味します。 option ntp-servers ip-address [, ip-address... ]; 本オプションは、クライアントが利用可能な NTP (RFC 1035) サーバを示す IP アドレスを指定します。サーバは、優先されるものから順にリストし て ください。 option nwip-domain string; NetWare/IP クライアントが使用すべき NetWare/IP ドメインの名前です。 option nwip-suboptions string; NetWare/IP クライアント用のサブオプションのシーケンスです。詳しくは RFC2242 を参照してください。通常、本オプションは特定の NetWare/IP サ ブオプションを指定することで設定されます。さらなる情報は「NetWare/IP サブオプション」の章を参照してください。 option path-mtu-aging-timeout uint32; 本オプションは、RFC 1191 で定義される機構で発見されたパス MTU 値のエ ージングに使用するタイムアウト (秒単位) を指定します。 option path-mtu-plateau-table uint16 [, uint16... ]; 本オプションは、RFC 1191 で定義されるパス MTU 探索 (Path MTU Discov- ery) 実施時に使用される MTU のサイズの表を指定します。表の書式は、最 小から順に最大までの、16 ビット符号無し整数のリストです。最小 MTU は 68 より小さくてはなりません。 option perform-mask-discovery flag; 本オプションは、クライアントが ICMP を使用してサブネットマスク探索を 実 施すべきかを指定します。値 false は、クライアントがマスク探索を実 施すべきでないことを意味します。値 true は、クライアントがマスク探索 を実施すべきであることを意味します。 option policy-filter ip-address ip-address [, ip-address ip-address...]; 本オプションは、非ローカルな指定経路制御に対するポリシフィルタを指定 します。フィルタは、IP アドレスとマスクの組のリストからなり、到着 す る 指定経路制御されたデータグラム用のフィルタとなる宛先/マスクの組を 指定します。 次ホップアドレスがフィルタのいずれにも適合しない指定経路制御されたデ ータグラムは、クライアントが破棄すべきです。 さらなる情報は STD 3 (RFC1122) を参照してください。 option pop-server ip-address [, ip-address... ]; POP3 サーバオプションは、クライアントが利用可能な POP3 のリストを指 定します。サーバは、優先されるものから順にリストしてください。 option resource-location-servers ip-address [, ip-address...]; 本オプションは、クライアントが利用可能な RFC 887 リソースロケーシ ョ ンサーバのリストを指定します。サーバは、優先されるものから順にリスト してください。 option root-path text; 本オプションは、クライアントのルートディスクが含まれるパス名を指定し ます。パスの書式は、NVT ASCII 文字集合の文字からなる文字列です。 option router-discovery flag; 本 オ プションは、RFC 1256 で定義されるルータ探索 (Router Discovery) 機構を使用して、ルータを要請すべきかを指定します。値 false は、ク ラ イアントがルータ探索を実施すべきでないことを意味します。値 true は、 クライアントはルータ探索を実施すべきであることを意味します。 option router-solicitation-address ip-address; 本オプションは、クライアントのルータ要請の送出先アドレスを指定します 。 option routers ip-address [, ip-address... ]; routers オプションは、クライアントのサブネット上にあるルータの IP ア ドレスのリストを指定します。ルータは、優先されるものから順にリストし てください。 option slp-directory-agent boolean ip-address [, ip-address... ]; 本オプションは、2 つの項目を指定します: 1 つ以上のサービスロケーショ ンプロトコルディレクトリエージェ ン ト (Service Location Protocol Directory Agent) の IP アドレスと、これらのアドレスの使用が強制的か どうかです。最初のブール値が true であれば、SLP エージェントは、ただ 与えられた IP アドレスのみを使用すべきです。値が false であれば、SLP エージェントは、SLP エージェントの能動的もしくは受動的なマルチキャス ト 探索を追加で行っても構いません (詳しくは RFC2165 を参照してくださ い)。 本オプションと slp-service-scope オプションにおいて、「SLP エージ ェ ン ト」とは、DHCP プロトコルを用いて設定されたマシン上で動作している サービスロケーションプロトコルエージェントを指していることに注意して ください。 また、いくつかの企業は SLP を NDS と呼んでいることも気を付けてくださ い。もし NDS ディレクトリエージェントがあり、そのアドレスを設定す る 必 要がある場合は、 slp-directory-agent オプションが利用できるはずで す。 option slp-service-scope boolean text; サービスロケーションプロトコルのサービススコープオプションは、 2 つ の項目を指定します: SLP 用のサービススコープのリストと、このリストの 使用が強制的かどうかです。最初のブール値が true であれば、SLP エージ ェントは、本オプションにより提供されるスコープのリストのみを使用すべ きです。そうでなければ、このオプションで提供されるリストに優先して、 それぞれの固有的の設定を使っても構いません。 text 文字列は、SLP エージェントが使用すべきスコープの、コンマ区切り のリストとしてください。これは省略可能で、その場合 SLP エージェン ト は、自分が知っているすべてのディレクトリエージェントのスコープの一括 リストを使います。 option smtp-server ip-address [, ip-address... ]; SMTP サーバオプションは、クライアントが利用可能な SMTP サーバのリ ス トを指定します。サーバは、優先されるものから順にリストしてください。 option static-routes ip-address ip-address [, ip-address ip-address...]; 本オプションは、クライアントが経路キャッシュに組み込むべき静的経路の リストを指定します。同じ宛先に対して複数の経路が指定されている場合は 、優先度が低くなる順序でリストされます。 経路は IP アドレスの組のリストからなります。最初のアドレスは宛先アド レ スであり、 2 番目のアドレスはその宛先に対するルータのアドレスです 。 デフォルト経路 (0.0.0.0) は、静的経路に対しては不正な宛先です。デ フ ォ ルト経路を指定するには、 routers オプションを使用してください。ま た、本オプションは、クラスレスな IP 経路制御を意図したものではないこ とに注意して下さい。これはサブネットマスクを含んでいません。現在、ク ラスレスな IP 経路制御は、もっとも広く展開されている経路制御標準なの で、本オプションは実質的に無意味です。そして、マイクロソフト DHCP ク ライアントをはじめとするよく知られた DHCP クライアントには実装されて いません。 option streettalk-directory-assistance-server ip-address [, ip-address...]; StreetTalk Directory Assistance (STDA) サーバオプションは、クライア ントが利用可能な STDA のリストを指定します。サーバは、優先されるもの から順にリストしてください。 option streettalk-server ip-address [, ip-address... ]; StreetTalk サーバオプションは、クライアントが利用可能な StreetTalk のリストを指定します。サーバは、優先されるものから順にリストしてくだ さい。 option subnet-mask ip-address; サブネットマスクオプションは、RFC 950 に従って、クライアントのサブネ ットマスクを指定します。スコープ中のどこにもサブネットマスクオプショ ンが指定されていない場合、最終手段として、dhcpd は、アドレスを割り当 てようとしているネットワークのサブネット宣言から、サブネットマスクを 使用します。しかし、アドレスを割り当てようとしているネットワークのス コープ中の どのようなサブネットマスクオプション宣言であっても、サ ブ ネット宣言で指定されたサブネットマスクに優先します。 option subnet-selection string; ( 要求が出されたサブネットにつながれたリレーサーバのアドレスに基づい て) 通常選択されるであろうものではないサブネットのアドレスが必要な場 合 、クライアントが送出します。 RFC3011 を参照してください。このサー バにおいて使われるオプションナンバは 118 です。このナンバは以前か ら ずっと定義されていたナンバではなく、違う値を使用するクライアントも存 在することに注意してください。このオプションの使用は少々実験的である と考えるべきでしょう! 本オプションは、サーバではユーザが設定することはできません。 option swap-server ip-address; 本オプションは、クライアントのスワップサーバの IP アドレスを指定しま す。 option tcp-keepalive-garbage flag; 本オプションは、古い実装との互換性のために、ゴミのオクテットと一緒に 、 TCP キープアライブメッセージをクライアントが送るべきかを指定しま す。値 false は、ゴミのオクテットを送るべきでないことを意味します 。 値 true は、ゴミのオクテットを送るべきであることを意味します。 option tcp-keepalive-interval uint32; 本オプションは、クライアントの TCP がキープアライブ (keepalive) メッ セージを TCP 接続上に送信する前に待つべき間隔 (秒単位) を指定しま す 。 時間は 32 ビット符号無し整数で指定します。値 0 は、アプリケーショ ンが明示的に要求しない限り、クライアントが接続上にキープアライブメッ セージを生成すべきでないことを意味します。 option tftp-server-name text; 本オプションは TFTP サーバを指定するのに使用され、クライアントがサポ ートしている場合には server-name 宣言と同じ効果を持ちます。 BOOTP ク ライアントは、本オプションをサポートしないでしょう。 DHCP クライアン トによってはサポートしているものがあり、実際必須としているものがあり ます。 option time-offset int32; time-offset オプションは、協定世界時 (UTC) を基点として、クライアン トのサブネットのオフセットを秒で指定します。 option time-servers ip-address [, ip-address... ]; time-server オプションは、クライアントが利用可能な RFC 868 時刻サ ー バのリストを指定します。サーバは、優先されるものから順にリストしてく ださい。 option trailer-encapsulation flag; 本オプションは、ARP プロトコル使用時に、クライアントがトレイラ使用の ネ ゴシエーション (RFC 893 [14]) をすべきかを指定します。値 false は 、クライアントがトレイラ使用を試みるべきでないと意味します。値 true は、クライアントがトレイラ使用を試みるべきであると意味します。 option uap-servers text; 本 オプションは、ユーザ認証プロトコル (UAP) に包まれた認証要求を処理 する能力のあるユーザ認証サービスをそれぞれ指している URL のリスト を 指定します。 UAP サーバは HTTP 1.1 接続も SSLv3 接続も受け取ることが できます。リストに含まれた URL にポート部分が含まれてない場合は、 通 常のデフォルトポートが仮定されます (つまり http には 80 番、https に は 443 番)。リストに含まれた URL にパスの部分が含まれてない場合は 、 パスは /uap と仮定されます。 2 つ以上の URL がこのリストに指定された 場合、URL は空白で区切られます。 option user-class string; 本オプションは、ユーザが識別情報をクライアントに指定する手段として、 い くつかの DHCP クライアントで使われます。これは vendor-class-iden- tifier オプションと同様に使われますが、その値は、ベンダではなく、 ユ ーザによって指定されます。最近のほとんどの DHCP クライアントは、この 識別子に値を指定するためのユーザインタフェースを備えています。この識 別子は、通常テキスト文字列です。 option vendor-class-identifier string; 本オプションは、ベンダタイプや、可能であれば DHCP クライアントの設定 を識別するために、いくつかの DHCP クライアントで使われます。この情報 の内容は、ベンダ固有のバイト文字列で、標準では規定されていません。ク ライアントが送出するベンダクラス識別子を確認するには、以下の設 定 を DHCP サーバ設定ファイルに加えてください: set vendor-class option vendor-class-identifier; こ の設定は、DHCP サーバのリースデータベースファイル中の、以下のよう な set 文を持つ vendor-class-identifier オプションを送ってくるクライ アントすべてのエントリに作用します。 set vendor-class "SUNW.Ultra-5_10"; vendor-class-identifier オ プションは、通常 DHCP Server によって、 vendor-encapsulated-options オプション中で返されるオプションを決定す るのに使われます。さらなる情報は、dhcpd.conf マニュアルページの VEN- DOR ENCAPSULATED OPTIONS の章を参照してください。 option vendor-encapsulated-options string; vendor-encapsulated-options オプションは、1 つのベンダ固有値、もしく は 1 つまたはそれ以上のベンダ固有サブオプションを含みます。本オプシ ョンは、通常 DHCP サーバの設定ファイルで設定されるものではありません 。通常は、ベンダクラスがベンダ毎に定義され、ベンダクラスサブオプショ ンが定義され、そのサブオプションの値が定義され、DHCP サーバはそれ ら をもとに応答を組み上げます。 よ く 知られた DHCP クライアントベンダ (今のところ Microsoft Windows 2000 DHCP クライアント) 向けのいくつかのデフォルトの動作では、このオ プションは自動的に設定されますが、その他のものに関しては、手動で設定 しなければなりません。詳細 は dhcpd.conf の VENDOR ENCAPSULATED OPTIONS の章を参照してください。 option www-server ip-address [, ip-address... ]; WWW サーバオプションは、クライアントが利用可能な WWW のリストを指定 します。サーバは、優先されるものから順にリストしてください。 option x-display-manager ip-address [, ip-address... ]; 本オプションは、クライアントが利用可能な X Window System ディスプ レ イマネージャを実行しているシステムのリストを指定します。アドレスは、 優先されるものから順にリストしてください。 リレーエージェント情報オプション IETF ドラフト draft-ietf-dhc-agent-options-11.txt には、 DHCP リレー エ ー ジェントが DHCP パケットを DHCP サーバに転送する際、 DHCP パケットに 付加することのできる一連のカプセル化されたオプションが定義されていま す 。 サーバは、これらのオプションに基づき、アドレス割当の決定 (や、その他 の判断) を行うことができます。またサーバは、リレーエージェントを通し て 返 されるどのパケットにもこれらのオプションを入れて返します。これによっ てリレーエージェントは、配送やアカウンティングなどを行うために、これ ら のオプションに含まれる情報を利用できます。 現在のドラフトには 2 つのオプションが定義されています。 DHCP サーバでこ れらのオプションを参照するには、オプション空間名 "agent" のあとにピリオ ド をつけ、その後にオプション名を続けてください。サーバでこれらのオプシ ョンの値を定義することは、通常あまり有効ではありませんが、許容されて い ます。これらのオプションは、クライアントではサポートされていません。 option agent.circuit-id string; circuit-id サブオプションは、クライアントからサーバへの DHCP パケッ トを受け取ったサーキットを示す、エージェントローカルなサーキット識別 子 をエンコードしています。これは、DHCP 応答を適切なサーキットへと送 り返せるよう、エージェントによって使われることを意図しています。現在 、このオプションの書式の定義はベンダ依存となっており、多分このまま残 されるでしょう。しかし将来この書式が標準化される可能性も、現在のドラ フトには残されています。 option agent.remote-id string; remote-id サブオプションは、サーキットの終端のリモートホストの情報を エンコードしています。これに含まれるであろう情報は、次のようなもので す 。呼出元 ID 情報、ユーザ名情報、リモート ATM アドレス、ケーブルモ デム ID、その他の同様な情報。原則的には、このオプションの意味はち ゃ んと定義されていません。しかし通常、サーキットの特定のリモートエンド に対して一意であるよう管理上保証された、なんらかのオブジェクトと考え るべきものです。 クライアント FQDN サブオプション 現在、インターネットドラフト draft-ietf-dhc-fqdn-option-00.txt で定義さ れているクライアント FQDN オプションは、まだ標準となってはいません。 し か しすでに十分広く利用されており、我々もこれを実装しています。オプショ ンの書式が複雑なため、ここでは、単独のオプションではなく、サブオプシ ョ ン 空間に実装しています。一般的には、本オプションは、ユーザによって設定 されるものではなく、自動 DNS 更新システムの一部として使われるべきもので す。 option fqdn.no-client-update flag; 本オプションがクライアントから送出された場合、これが true であれば、 クライアントは自分の A レコードを更新しないことを意味します。サー バ か らクライアントに送出された場合は、クライアントは自分の A レコード を更新する べきではない ことを意味します。 option fqdn.server-update flag; 本オプションがクライアントからサーバに送出された場合、サーバにクライ ア ントの A レコードの更新を要求しています。サーバから送出された場合 、サーバがクライアントの A レコードを更新した (もしくはもうすぐ更 新 するところ) であることを意味します。 option fqdn.encoded flag; true であった時、オプションに含まれるドメイン名が、ただの ASCII テキ ストではなく、DNS ワイヤフォーマットでエンコードされていることを示し て ます。クライアントは、自分が FQDN オプションの DNS ワイヤフォーマ ットをサポートしてない場合、通常このサブオプションを false に設定 し ます。サーバは常に、クライアントが設定したのと同じ値を設定して返すべ きです。この値が設定ファイルに設定されていた時は、fqdn.fqdn サブオプ ションをエンコードするフォーマットを制御します。 option fqdn.rcode1 flag; option fqdn.rcode2 flag; こ れらのオプションはそれぞれ、A レコードと PTR レコードの更新結果を 示します。これらは、DHCP サーバから DHCP クライアントへのみ送られ ま す。これらのフィールドの値は、DNS プロトコル規格により定義されていま す。 option fqdn.fqdn text; クライアントが使用を望むドメイン名を指定します。これは完全修飾された ド メイン名でも、単一のラベルでも構いません。もし名前に ’.’ 文字が含 まれなければ、その名前は完全修飾されておらず、サーバは通常、ローカル に定義されたドメイン中のその名前を更新します。 も しこれらのサブオプションを使用しようと思っているのであれば、クライア ント FQDN オプションのドラフト (もしくは、標準になった時はその標準) を 参 照することを強く推奨します。この文書は、そのドラフトに比べて大雑把で 不完全であり、クライアント FQDN オプション規格をすでに理解している人 に 参照されることを単に意図しているものです。 NetWare/IP サブオプション RFC2242 は、Novell の NetWare/IP クライアント用のカプセル化されたオプシ ョンの組を定義しています。 DHCP サーバにおいてこれらのオプションを使 用 す るには、オプション空間名 "nwip" の後にピリオドをつけ、その後にオプシ ョン名を続けてください。以下のオプションが指定できます: option nwip.nsq-broadcast flag; true であった場合、クライアントは、NetWare/IP サーバの位置を探すのに NetWare Nearest Server Query を使うべきです。本サブオプションが false であった場合、もしくは指定されなかった場合の Novell クライアン トの動作は規定されていません。 option nwip.preferred-dss ip-address [, ip-address... ]; 本サブオプションには、5 つまでの IP アドレスのリストを指定します。そ れぞれのアドレスは、NetWare ドメイン SAP/RIP サーバ (DSS) の IP アド レスです。 option nwip.nearest-nwip-server ip-address [, ip-address...]; 本サブオプションには、5 つまでの IP アドレスのリストを指定します。そ れぞれのアドレスは、近接の NetWare IP サー バ (Nearest NetWare IP Server) の IP アドレスです。 option nwip.autoretries uint8; 起動時に、NetWare/IP クライアントが、与えられた DSS サーバと何回通信 を試みるべきかを指定します。 option nwip.autoretry-secs uint8; 起動時に、NetWare/IP クライアントが、与えられた DSS サーバと通信を確 立する時に、リトライの間何秒待つべきかを指定します。 option nwip.nwip-1-1 uint8; true であった場合、NetWare/IP クライアントは NetWare/IP バージョン 1.1 をサポートしているべきです。これは、クライアントが NetWare/IP バ ージョン 1.1 のサーバと通信する時のみ必要です。 option nwip.primary-dss ip-address; NetWare/IP ドメインのプライマリドメイン SAP/RIP サービスサーバ (DSS) の IP アドレスを指定します。セカンダリ DSS サーバの設定 時 に 、Net- Ware/IP 管理ユーティリティは、この値をプライマリ DSS サーバとして使 用します。 新規オプションの定義 Internet Software Consortium DHCP クライアントとサーバは、新規オプシ ョ ン を定義する機構も提供しています。それぞれの DHCP オプションは、名前と コード、構造を持っています。名前は、使用者がオプションを参照するのに 使 用されます。コードは、DHCP サーバとクライアントがオプションを参照するの に使用する番号です。構造は、オプションの内容がどのようなものかを記述 し ています。 新 規オプションを定義するには、他のオプションでは使われていない名前を選 ぶ必要があります。例えば、"host-name" と言う名前は使用できません。と い う の も 、このマニュアルページに出てきたように、 DHCP プロトコルが既に host-name オプションを定義しているからです。このマニュアルページに出 て き ていないオプション名ならば使っても構いませんが、将来出てくるオプショ ンと重ならないように、オプション名の最初に独自の文字列をつけることは 、 多分いい考えでしょう。例えば、公式の DHCP オプションには "local" で始ま るものがないので、 "local-host-name" と言う名前は、いくらか安心して定義 できるでしょう。 名 前 を 選択したら、次はコードを選ばねばなりません。 DHCP オプションの 128 から 256 までのコードは、サイトローカルオプション用として予約されて い るので、この中のコードならどれでも選ぶことができます。実際には、プロ トコルを少々あいまいに解釈しているベンダがあり、 128 より大きい値のオプ シ ョンコードを使用しています。この問題を本当に回避する方法はありません が、実際にはそう大きな問題を引き起こすものではないでしょう。 オプションの構造とは、単にオプションのデータが表現されている形式です 。 現 在 ISC DHCP サーバは、整数、ブール値、文字列そして IP アドレスといっ た、いくつかの単純なデータ型をサポートしており、また単一データ型の配 列 や固定順のデータ型列の配列を定義することもできます。 新規オプションは、以下のように宣言されます: option new-name code new-code = definition ; new-name と new-code の値は、新規オプション用にあなたが選んだものです。 definition は、オプションの構造の定義です。 以下の単純なオプションの型定義がサポートされています: ブール値 option new-name code new-code = boolean ; ブール型のオプションは、on または off (もしくは true か false) の値を持 つフラグです。ブール型の使用例は、以下のようになります: option use-zephyr code 180 = boolean; option use-zephyr on; 整数 option new-name code new-code = sign integer width ; sign ト ークンは、空白、unsigned、signed のいずれかです。 width は 8, 16, 32 のいずれかで、整数の bit 数を示します。例えば、以下の 2 行 は 、sql-connection-max オプションの定義と使用法を示します: option sql-connection-max code 192 = unsigned integer 16; option sql-connection-max 1536; IP アドレス option new-name code new-code = ip-address ; IP アドレス型の構造を持つオプションは、ドメイン名もしくはドット区切りの 4 整数で表現されます。以下は、IP アドレス型の使用例です: option sql-server-address code 193 = ip-address; option sql-server-address sql.example.com; テキスト option new-name code new-code = text ; テキスト型のオプションは、ASCII テキスト文字列をエンコードします。例 え ば: option sql-default-connection-name code 194 = text; option sql-default-connection-name "PRODZA"; データ文字列 option new-name code new-code = string ; デ ータ文字列型のオプションは、本質的には単なるバイトの集合体です。テキ スト型のようにクオートされたテキストで指定されるか、もしくはコロン区 切 り の 16 進数のリストで指定されます。この時コロンで区切られた中身は、0 から FF の間の値でなければなりません。例えば: option sql-identification-token code 195 = string; option sql-identification-token 17:23:19:a6:42:ea:99:7c:22; カプセル化 option new-name code new-code = encapsulate identifier ; カプセル化型のオプションは、identifier で指定されたオプション空間の中身 を カプセル化します。現在 DHCP プロトコルに存在するカプセル化オプション の例は、 vendor-encapsulated-options オプション、netware-suboptions オ プション、 relay-agent-information オプションなどです。 option space local; option local.demo code 1 = text; option local-encapsulation code 197 = encapsulate local; option local.demo "demo"; 配列 オ プションは、テキスト型とデータ文字列型以外の上述のいかなるデータ型の 配列も含むことができます。テキスト型とデータ文字列型は、現在配列では サ ポートされていません。配列定義の例は以下の通りです: option kerberos-servers code 200 = array of ip-address; option kerberos-servers 10.20.10.1, 10.20.11.1; レコード オ プションは、データ型の列で構成されるデータ構造を含むこともできます。 これはしばしばレコード型と呼ばれます。例えば: option contrived-001 code 201 = { boolean, integer 32, text }; option contrived-001 on 1772 "contrivance"; またレコードの配列のオプションを持つこともできます。例えば: option new-static-routes code 201 = array of { ip-address, ip-address, ip-address, integer 8 }; option static-routes 10.0.0.0 255.255.255.0 net-0-rtr.example.com 1, 10.0.1.0 255.255.255.0 net-1-rtr.example.com 1, 10.2.0.0 255.255.224.0 net-2-0-rtr.example.com 3; ベンダカプセル化オプション DHCP プロトコルには、 vendor-encapsulated-options オプションが定義さ れ て います。ベンダは、このオプションによって、ベンダ固有のオプションを標 準 DHCP オプションに含めて送出することができます。 vendor-encapsulated- options オプションの書式は、書式が規定されていない一連のバイト列、もし くは一連のオプション列です。オプション列中のそれぞれのオプション は 、1 バイトのベンダ固有のオプションコードの後に 1 バイトのデータ長、そしてそ のデータ長で指定された大きさのデータが続いたもので構成されます (デー タ 長には、データ長自身やオプションコードは含まれません)。 本オプションの値は、2 つの方法のいずれかで設定されます。 1 番目の方法は 、単にデータを直接指定するものです。データの指定には、テキスト文字列 か コロンで区切られた 16 進数値を用います。例えば: option vendor-encapsulated-options 2:4:AC:11:41:1: 3:12:73:75:6e:64:68:63:70:2d:73:65:72:76:65:72:31:37:2d:31: 4:12:2f:65:78:70:6f:72:74:2f:72:6f:6f:74:2f:69:38:36:70:63; 本 オプションを設定する 2 番目の方法は、DHCP サーバにベンダ固有オプショ ンバッファを作成させるというものです。これをするには、以下の 4 つのこと を する必要があります: オプション空間を定義し、そのオプション空間内にオ プションを定義し、それらへ値を割り振り、最後にそのオプション空間が ven- dor-encapsulated-options オプションの生成に使用されることを指定します。 ベンダオプションが格納されるオプション空間を新規に定義するには、 option space 文を使用します: option space name ; こ の文書にこれまで書かれているように、この name は、オプション定義で使 用することができます。例えば: option space SUNW; option SUNW.server-address code 2 = ip-address; option SUNW.server-name code 3 = text; option SUNW.root-path code 4 = text; 一度、オプション空間とオプションの書式を定義したら、それらのオプショ ン の 値を定義するスコープを設定でき、それらのオプションをいつ使うかを指定 することができます。例えば、2 つの異なるクラスのクライアントを扱いた い と しましょう。前述の例で示したオプション空間の定義を使って、以下のよう に、クライアントから送られてきた vendor-class-identifier オプションに基 づ いて、異なるオプションの値を異なるクライアントに送出することができま す。 class "vendor-classes" { match option vendor-class-identifier; } option SUNW.server-address 172.17.65.1; option SUNW.server-name "sundhcp-server17-1"; subclass "vendor-classes" "SUNW.Ultra-5_10" { vendor-option-space SUNW; option SUNW.root-path "/export/root/sparc"; } subclass "vendor-classes" "SUNW.i86pc" { vendor-option-space SUNW; option SUNW.root-path "/export/root/i86pc"; } 先の例で見たように、通常のスコープルールを適用することで、グローバル な 値 をグローバルスコープ中に定義でき、特定のクラスに固有の値だけをローカ ルスコープに定義できます。 vendor-option-space 宣言を使うことで、 ven- dor-encapsulated-options オプションを構成するのに、SUNW オプション空間 内のオプションを使うよう DHCP サーバに指示することができます。 関連項目 dhclient.conf(5), dhcp-eval(5), dhclient(8), RFC2132, RFC2131 作者 Internet Software Consortium DHCP Distribution は、Vixie Labs との契 約 の も と で、Ted Lemon が記述しました。本プロジェクトの資金は、Internet Software Consortium が提供しました。 Internet Software Consortium に 関 する情報は、 http://www.isc.org にあります。 dhcpd-options(5)
dhcpd-options(5) dhcpd-options(5) NAME dhcp-options - Dynamic Host Configuration Protocol options DESCRIPTION The Dynamic Host Configuration protocol allows the client to receive options from the DHCP server describing the network configuration and various services that are available on the network. When configuring dhcpd(8) or dhclient(8) , options must often be declared. The syntax for declaring options, and the names and formats of the options that can be declared, are documented here. REFERENCE: OPTION STATEMENTS DHCP option statements always start with the option keyword, followed by an option name, followed by option data. The option names and data formats are described below. It is not necessary to exhaustively specify all DHCP options - only those options which are needed by clients must be specified. Option data comes in a variety of formats, as defined below: The ip-address data type can be entered either as an explicit IP address (e.g., 239.254.197.10) or as a domain name (e.g., haa- gen.isc.org). When entering a domain name, be sure that that domain name resolves to a single IP address. The ip6-address data specifies an IPv6 address, like ::1 or 3ffe:bbbb:aaaa:aaaa::1. The int32 data type specifies a signed 32-bit integer. The uint32 data type specifies an unsigned 32-bit integer. The int16 and uint16 data types specify signed and unsigned 16-bit integers. The int8 and uint8 data types specify signed and unsigned 8-bit integers. Unsigned 8-bit integers are also sometimes referred to as octets. The text data type specifies an NVT ASCII string, which must be enclosed in double quotes - for example, to specify a root-path option, the syntax would be option root-path "10.0.1.4:/var/tmp/rootfs"; The domain-name data type specifies a domain name, which must not be enclosed in double quotes. This data type is not used for any exist- ing DHCP options. The domain name is stored just as if it were a text option. The domain-list data type specifies a list of domain names, enclosed in double quotes and separated by commas ("example.com", "foo.exam- ple.com"). The flag data type specifies a boolean value. Booleans can be either true or false (or on or off, if that makes more sense to you). The string data type specifies either an NVT ASCII string enclosed in double quotes, or a series of octets specified in hexadecimal, sepa- rated by colons. For example: option dhcp-client-identifier "CLIENT-FOO"; or option dhcp-client-identifier 43:4c:49:45:54:2d:46:4f:4f; The destination-descriptor describe the IP subnet number and subnet mask of a particular destination using a compact encoding. This encoding consists of one octet describing the width of the subnet mask, followed by all the significant octets of the subnet number. The fol- lowing table contains some examples of how various subnet number/mask combinations can be encoded: Subnet number Subnet mask Destination descriptor 0 0 0 10.0.0.0 255.0.0.0 8.10 10.0.0.0 255.255.255.0 24.10.0.0 10.17.0.0 255.255.0.0 16.10.17 10.27.129.0 255.255.255.0 24.10.27.129 10.229.0.128 255.255.255.128 25.10.229.0.128 10.198.122.47 255.255.255.255 32.10.198.122.47 SETTING OPTION VALUES USING EXPRESSIONS Sometimes it’s helpful to be able to set the value of a DHCP option based on some value that the client has sent. To do this, you can use expression evaluation. The dhcp-eval(5) manual page describes how to write expressions. To assign the result of an evaluation to an option, define the option as follows: option my-option = expression ; For example: option hostname = binary-to-ascii (16, 8, "-", substring (hardware, 1, 6)); STANDARD DHCPV4 OPTIONS The documentation for the various options mentioned below is taken from the latest IETF draft document on DHCP options. Options not listed below may not yet be implemented, but it is possible to use such options by defining them in the configuration file. Please see the DEFINING NEW OPTIONS heading later in this document for more informa- tion. Some of the options documented here are automatically generated by the DHCP server or by clients, and cannot be configured by the user. The value of such an option can be used in the configuration file of the receiving DHCP protocol agent (server or client), for example in condi- tional expressions. However, the value of the option cannot be used in the configuration file of the sending agent, because the value is determined only after the configuration file has been processed. In the following documentation, such options will be shown as "not user con- figurable" The standard options are: option all-subnets-local flag; This option specifies whether or not the client may assume that all subnets of the IP network to which the client is connected use the same MTU as the subnet of that network to which the client is directly connected. A value of true indicates that all subnets share the same MTU. A value of false means that the client should assume that some subnets of the directly connected network may have smaller MTUs. option arp-cache-timeout uint32; This option specifies the timeout in seconds for ARP cache entries. option bcms-controller-address ip-address [, ip-address... ]; This option configures a list of IPv4 addresses for use as Broadcast and Multicast Controller Servers ("BCMS"). option bcms-controller-names domain-list; This option contains the domain names of local Broadcast and Multi- cast Controller Servers ("BCMS") controllers which the client may use. option bootfile-name text; This option is used to identify a bootstrap file. If supported by the client, it should have the same effect as the filename declara- tion. BOOTP clients are unlikely to support this option. Some DHCP clients will support it, and others actually require it. option boot-size uint16; This option specifies the length in 512-octet blocks of the default boot image for the client. option broadcast-address ip-address; This option specifies the broadcast address in use on the client’s subnet. Legal values for broadcast addresses are specified in sec- tion 3.2.1.3 of STD 3 (RFC1122). option cookie-servers ip-address [, ip-address... ]; The cookie server option specifies a list of RFC 865 cookie servers available to the client. Servers should be listed in order of pref- erence. option default-ip-ttl uint8; This option specifies the default time-to-live that the client should use on outgoing datagrams. option default-tcp-ttl uint8; This option specifies the default TTL that the client should use when sending TCP segments. The minimum value is 1. option default-url string; The format and meaning of this option is not described in any stan- dards document, but is claimed to be in use by Apple Computer. It is not known what clients may reasonably do if supplied with this option. Use at your own risk. option dhcp-client-identifier string; This option can be used to specify a DHCP client identifier in a host declaration, so that dhcpd can find the host record by matching against the client identifier. Please be aware that some DHCP clients, when configured with client identifiers that are ASCII text, will prepend a zero to the ASCII text. So you may need to write: option dhcp-client-identifier "\0foo"; rather than: option dhcp-client-identifier "foo"; option dhcp-lease-time uint32; This option is used in a client request (DHCPDISCOVER or DHCPRE- QUEST) to allow the client to request a lease time for the IP address. In a server reply (DHCPOFFER), a DHCP server uses this option to specify the lease time it is willing to offer. This option is not directly user configurable in the server; refer to the max-lease-time and default-lease-time server options in dhcpd.conf(5). option dhcp-max-message-size uint16; This option, when sent by the client, specifies the maximum size of any response that the server sends to the client. When specified on the server, if the client did not send a dhcp-max-message-size option, the size specified on the server is used. This works for BOOTP as well as DHCP responses. option dhcp-message text; This option is used by a DHCP server to provide an error message to a DHCP client in a DHCPNAK message in the event of a failure. A client may use this option in a DHCPDECLINE message to indicate why the client declined the offered parameters. This option is not user configurable. option dhcp-message-type uint8; This option, sent by both client and server, specifies the type of DHCP message contained in the DHCP packet. Possible values (taken directly from RFC2132) are: 1 DHCPDISCOVER 2 DHCPOFFER 3 DHCPREQUEST 4 DHCPDECLINE 5 DHCPACK 6 DHCPNAK 7 DHCPRELEASE 8 DHCPINFORM This option is not user configurable. option dhcp-option-overload uint8; This option is used to indicate that the DHCP ’sname’ or ’file’ fields are being overloaded by using them to carry DHCP options. A DHCP server inserts this option if the returned parameters will exceed the usual space allotted for options. If this option is present, the client interprets the specified addi- tional fields after it concludes interpretation of the standard option fields. Legal values for this option are: 1 the ’file’ field is used to hold options 2 the ’sname’ field is used to hold options 3 both fields are used to hold options This option is not user configurable. option dhcp-parameter-request-list uint16 [, uint16... ]; This option, when sent by the client, specifies which options the client wishes the server to return. Normally, in the ISC DHCP client, this is done using the request statement. If this option is not specified by the client, the DHCP server will normally return every option that is valid in scope and that fits into the reply. When this option is specified on the server, the server returns the specified options. This can be used to force a client to take options that it hasn’t requested, and it can also be used to tailor the response of the DHCP server for clients that may need a more limited set of options than those the server would normally return. option dhcp-rebinding-time uint32; This option specifies the number of seconds from the time a client gets an address until the client transitions to the REBINDING state. This option is not user configurable. option dhcp-renewal-time uint32; This option specifies the number of seconds from the time a client gets an address until the client transitions to the RENEWING state. This option is not user configurable. option dhcp-requested-address ip-address; This option is used by the client in a DHCPDISCOVER to request that a particular IP address be assigned. This option is not user configurable. option dhcp-server-identifier ip-address; This option is used in DHCPOFFER and DHCPREQUEST messages, and may optionally be included in the DHCPACK and DHCPNAK messages. DHCP servers include this option in the DHCPOFFER in order to allow the client to distinguish between lease offers. DHCP clients use the contents of the ’server identifier’ field as the destination address for any DHCP messages unicast to the DHCP server. DHCP clients also indicate which of several lease offers is being accepted by includ- ing this option in a DHCPREQUEST message. The value of this option is the IP address of the server. This option is not directly user configurable. See the server-iden- tifier server option in dhcpd.conf(5). option domain-name text; This option specifies the domain name that client should use when resolving hostnames via the Domain Name System. option domain-name-servers ip-address [, ip-address... ]; The domain-name-servers option specifies a list of Domain Name Sys- tem (STD 13, RFC 1035) name servers available to the client. Servers should be listed in order of preference. option domain-search domain-list; The domain-search option specifies a ’search list’ of Domain Names to be used by the client to locate not-fully-qualified domain names. The difference between this option and historic use of the domain- name option for the same ends is that this option is encoded in RFC1035 compressed labels on the wire. For example: option domain-search "example.com", "sales.example.com", "eng.example.com"; option extensions-path text; This option specifies the name of a file containing additional options to be interpreted according to the DHCP option format as specified in RFC2132. option finger-server ip-address [, ip-address... ]; The Finger server option specifies a list of Finger servers avail- able to the client. Servers should be listed in order of prefer- ence. option font-servers ip-address [, ip-address... ]; This option specifies a list of X Window System Font servers avail- able to the client. Servers should be listed in order of preference. option host-name string; This option specifies the name of the client. The name may or may not be qualified with the local domain name (it is preferable to use the domain-name option to specify the domain name). See RFC 1035 for character set restrictions. This option is only honored by dhclient-script(8) if the hostname for the client machine is not set. option ieee802-3-encapsulation flag; This option specifies whether or not the client should use Ethernet Version 2 (RFC 894) or IEEE 802.3 (RFC 1042) encapsulation if the interface is an Ethernet. A value of false indicates that the client should use RFC 894 encapsulation. A value of true means that the client should use RFC 1042 encapsulation. option ien116-name-servers ip-address [, ip-address... ]; The ien116-name-servers option specifies a list of IEN 116 name servers available to the client. Servers should be listed in order of preference. option impress-servers ip-address [, ip-address... ]; The impress-server option specifies a list of Imagen Impress servers available to the client. Servers should be listed in order of pref- erence. option interface-mtu uint16; This option specifies the MTU to use on this interface. The mini- mum legal value for the MTU is 68. option ip-forwarding flag; This option specifies whether the client should configure its IP layer for packet forwarding. A value of false means disable IP for- warding, and a value of true means enable IP forwarding. option irc-server ip-address [, ip-address... ]; The IRC server option specifies a list of IRC servers available to the client. Servers should be listed in order of preference. option log-servers ip-address [, ip-address... ]; The log-server option specifies a list of MIT-LCS UDP log servers available to the client. Servers should be listed in order of pref- erence. option lpr-servers ip-address [, ip-address... ]; The LPR server option specifies a list of RFC 1179 line printer servers available to the client. Servers should be listed in order of preference. option mask-supplier flag; This option specifies whether or not the client should respond to subnet mask requests using ICMP. A value of false indicates that the client should not respond. A value of true means that the client should respond. option max-dgram-reassembly uint16; This option specifies the maximum size datagram that the client should be prepared to reassemble. The minimum legal value is 576. option merit-dump text; This option specifies the path-name of a file to which the client’s core image should be dumped in the event the client crashes. The path is formatted as a character string consisting of characters from the NVT ASCII character set. option mobile-ip-home-agent ip-address [, ip-address... ]; This option specifies a list of IP addresses indicating mobile IP home agents available to the client. Agents should be listed in order of preference, although normally there will be only one such agent. option nds-context string; The nds-context option specifies the name of the initial Netware Directory Service for an NDS client. option nds-servers ip-address [, ip-address... ]; The nds-servers option specifies a list of IP addresses of NDS servers. option nds-tree-name string; The nds-tree-name option specifies NDS tree name that the NDS client should use. option netbios-dd-server ip-address [, ip-address... ]; The NetBIOS datagram distribution server (NBDD) option specifies a list of RFC 1001/1002 NBDD servers listed in order of preference. option netbios-name-servers ip-address [, ip-address...]; The NetBIOS name server (NBNS) option specifies a list of RFC 1001/1002 NBNS name servers listed in order of preference. NetBIOS Name Service is currently more commonly referred to as WINS. WINS servers can be specified using the netbios-name-servers option. option netbios-node-type uint8; The NetBIOS node type option allows NetBIOS over TCP/IP clients which are configurable to be configured as described in RFC 1001/1002. The value is specified as a single octet which identi- fies the client type. Possible node types are: 1 B-node: Broadcast - no WINS 2 P-node: Peer - WINS only 4 M-node: Mixed - broadcast, then WINS 8 H-node: Hybrid - WINS, then broadcast option netbios-scope string; The NetBIOS scope option specifies the NetBIOS over TCP/IP scope parameter for the client as specified in RFC 1001/1002. See RFC1001, RFC1002, and RFC1035 for character-set restrictions. option netinfo-server-address ip-address [, ip-address... ]; The netinfo-server-address option has not been described in any RFC, but has been allocated (and is claimed to be in use) by Apple Com- puters. It’s hard to say if the above is the correct format, or what clients might be expected to do if values were configured. Use at your own risk. option netinfo-server-tag text; The netinfo-server-tag option has not been described in any RFC, but has been allocated (and is claimed to be in use) by Apple Computers. It’s hard to say if the above is the correct format, or what clients might be expected to do if values were configured. Use at your own risk. option nis-domain text; This option specifies the name of the client’s NIS (Sun Network Information Services) domain. The domain is formatted as a charac- ter string consisting of characters from the NVT ASCII character set. option nis-servers ip-address [, ip-address... ]; This option specifies a list of IP addresses indicating NIS servers available to the client. Servers should be listed in order of pref- erence. option nisplus-domain text; This option specifies the name of the client’s NIS+ domain. The domain is formatted as a character string consisting of characters from the NVT ASCII character set. option nisplus-servers ip-address [, ip-address... ]; This option specifies a list of IP addresses indicating NIS+ servers available to the client. Servers should be listed in order of pref- erence. option nntp-server ip-address [, ip-address... ]; The NNTP server option specifies a list of NNTP servesr available to the client. Servers should be listed in order of preference. option non-local-source-routing flag; This option specifies whether the client should configure its IP layer to allow forwarding of datagrams with non-local source routes (see Section 3.3.5 of [4] for a discussion of this topic). A value of false means disallow forwarding of such datagrams, and a value of true means allow forwarding. option ntp-servers ip-address [, ip-address... ]; This option specifies a list of IP addresses indicating NTP (RFC 1035) servers available to the client. Servers should be listed in order of preference. option nwip-domain string; The name of the NetWare/IP domain that a NetWare/IP client should use. option nwip-suboptions string; A sequence of suboptions for NetWare/IP clients - see RFC2242 for details. Normally this option is set by specifying specific Net- Ware/IP suboptions - see the NETWARE/IP SUBOPTIONS section for more information. option path-mtu-aging-timeout uint32; This option specifies the timeout (in seconds) to use when aging Path MTU values discovered by the mechanism defined in RFC 1191. option path-mtu-plateau-table uint16 [, uint16... ]; This option specifies a table of MTU sizes to use when performing Path MTU Discovery as defined in RFC 1191. The table is formatted as a list of 16-bit unsigned integers, ordered from smallest to largest. The minimum MTU value cannot be smaller than 68. option perform-mask-discovery flag; This option specifies whether or not the client should perform sub- net mask discovery using ICMP. A value of false indicates that the client should not perform mask discovery. A value of true means that the client should perform mask discovery. option policy-filter ip-address ip-address [, ip-address ip-address...]; This option specifies policy filters for non-local source routing. The filters consist of a list of IP addresses and masks which spec- ify destination/mask pairs with which to filter incoming source routes. Any source routed datagram whose next-hop address does not match one of the filters should be discarded by the client. See STD 3 (RFC1122) for further information. option pop-server ip-address [, ip-address... ]; The POP3 server option specifies a list of POP3 servers available to the client. Servers should be listed in order of preference. option resource-location-servers ip-address [, ip-address...]; This option specifies a list of RFC 887 Resource Location servers available to the client. Servers should be listed in order of pref- erence. option root-path text; This option specifies the path-name that contains the client’s root disk. The path is formatted as a character string consisting of characters from the NVT ASCII character set. option router-discovery flag; This option specifies whether or not the client should solicit routers using the Router Discovery mechanism defined in RFC 1256. A value of false indicates that the client should not perform router discovery. A value of true means that the client should perform router discovery. option router-solicitation-address ip-address; This option specifies the address to which the client should trans- mit router solicitation requests. option routers ip-address [, ip-address... ]; The routers option specifies a list of IP addresses for routers on the client’s subnet. Routers should be listed in order of prefer- ence. option slp-directory-agent boolean ip-address [, ip-address... ]; This option specifies two things: the IP addresses of one or more Service Location Protocol Directory Agents, and whether the use of these addresses is mandatory. If the initial boolean value is true, the SLP agent should just use the IP addresses given. If the value is false, the SLP agent may additionally do active or passive multicast discovery of SLP agents (see RFC2165 for details). Please note that in this option and the slp-service-scope option, the term "SLP Agent" is being used to refer to a Service Location Protocol agent running on a machine that is being configured using the DHCP protocol. Also, please be aware that some companies may refer to SLP as NDS. If you have an NDS directory agent whose address you need to config- ure, the slp-directory-agent option should work. option slp-service-scope boolean text; The Service Location Protocol Service Scope Option specifies two things: a list of service scopes for SLP, and whether the use of this list is mandatory. If the initial boolean value is true, the SLP agent should only use the list of scopes provided in this option; otherwise, it may use its own static configuration in pref- erence to the list provided in this option. The text string should be a comma-separated list of scopes that the SLP agent should use. It may be omitted, in which case the SLP Agent will use the aggregated list of scopes of all directory agents known to the SLP agent. option smtp-server ip-address [, ip-address... ]; The SMTP server option specifies a list of SMTP servers available to the client. Servers should be listed in order of preference. option static-routes ip-address ip-address [, ip-address ip-address...]; This option specifies a list of static routes that the client should install in its routing cache. If multiple routes to the same desti- nation are specified, they are listed in descending order of prior- ity. The routes consist of a list of IP address pairs. The first address is the destination address, and the second address is the router for the destination. The default route (0.0.0.0) is an illegal destination for a static route. To specify the default route, use the routers option. Also, please note that this option is not intended for classless IP routing - it does not include a subnet mask. Since classless IP routing is now the most widely deployed routing standard, this option is virtually useless, and is not implemented by any of the popular DHCP clients, for example the Microsoft DHCP client. NOTE to Fedora dhclient users: dhclient-script interprets trailing 0 octets of the target as indi- cating the subnet class of the route, so for the following static- routes value: option static-routes 172.0.0.0 172.16.2.254, 192.168.0.0 192.168.2.254; dhclient-script will create routes: 172/8 via 172.16.2.254 dev $interface 192.168/16 via 192.168.2.254 dev $interface option classless-static-routes destination-descriptor ip-address [, destination-descriptor ip-address...]; This option (see RFC3442) specifies a list of classless static routes that the client should install in its routing cache. This option can contain one or more static routes, each of which consists of a destination descriptor and the IP address of the router that should be used to reach that destination. Many clients may not implement the Classless Static Routes option. DHCP server administrators should therefore configure their DHCP servers to send both a Router option and a Classless Static Routes option, and should specify the default router(s) both in the Router option and in the Classless Static Routes option. If the DHCP server returns both a Classless Static Routes option and a Router option, the DHCP client ignores the Router option. option streettalk-directory-assistance-server ip-address [, ip-address...]; The StreetTalk Directory Assistance (STDA) server option specifies a list of STDA servers available to the client. Servers should be listed in order of preference. option streettalk-server ip-address [, ip-address... ]; The StreetTalk server option specifies a list of StreetTalk servers available to the client. Servers should be listed in order of preference. option subnet-mask ip-address; The subnet mask option specifies the client’s subnet mask as per RFC 950. If no subnet mask option is provided anywhere in scope, as a last resort dhcpd will use the subnet mask from the subnet declara- tion for the network on which an address is being assigned. How- ever, any subnet-mask option declaration that is in scope for the address being assigned will override the subnet mask specified in the subnet declaration. option subnet-selection string; Sent by the client if an address is required in a subnet other than the one that would normally be selected (based on the relaying address of the connected subnet the request is obtained from). See RFC3011. Note that the option number used by this server is 118; this has not always been the defined number, and some clients may use a different value. Use of this option should be regarded as slightly experimental! This option is not user configurable in the server. option swap-server ip-address; This specifies the IP address of the client’s swap server. option tcp-keepalive-garbage flag; This option specifies whether or not the client should send TCP keepalive messages with an octet of garbage for compatibility with older implementations. A value of false indicates that a garbage octet should not be sent. A value of true indicates that a garbage octet should be sent. option tcp-keepalive-interval uint32; This option specifies the interval (in seconds) that the client TCP should wait before sending a keepalive message on a TCP connection. The time is specified as a 32-bit unsigned integer. A value of zero indicates that the client should not generate keepalive messages on connections unless specifically requested by an application. option tftp-server-name text; This option is used to identify a TFTP server and, if supported by the client, should have the same effect as the server-name declara- tion. BOOTP clients are unlikely to support this option. Some DHCP clients will support it, and others actually require it. option time-offset int32; The time-offset option specifies the offset of the client’s subnet in seconds from Coordinated Universal Time (UTC). option time-servers ip-address [, ip-address... ]; The time-server option specifies a list of RFC 868 time servers available to the client. Servers should be listed in order of pref- erence. option trailer-encapsulation flag; This option specifies whether or not the client should negotiate the use of trailers (RFC 893 [14]) when using the ARP protocol. A value of false indicates that the client should not attempt to use trail- ers. A value of true means that the client should attempt to use trailers. option uap-servers text; This option specifies a list of URLs, each pointing to a user authentication service that is capable of processing authentication requests encapsulated in the User Authentication Protocol (UAP). UAP servers can accept either HTTP 1.1 or SSLv3 connections. If the list includes a URL that does not contain a port component, the nor- mal default port is assumed (i.e., port 80 for http and port 443 for https). If the list includes a URL that does not contain a path component, the path /uap is assumed. If more than one URL is spec- ified in this list, the URLs are separated by spaces. option user-class string; This option is used by some DHCP clients as a way for users to spec- ify identifying information to the client. This can be used in a similar way to the vendor-class-identifier option, but the value of the option is specified by the user, not the vendor. Most recent DHCP clients have a way in the user interface to specify the value for this identifier, usually as a text string. option vendor-class-identifier string; This option is used by some DHCP clients to identify the vendor type and possibly the configuration of a DHCP client. The information is a string of bytes whose contents are specific to the vendor and are not specified in a standard. To see what vendor class identifier clients are sending, you can write the following in your DHCP server configuration file: set vendor-string = option vendor-class-identifier; This will result in all entries in the DHCP server lease database file for clients that sent vendor-class-identifier options having a set statement that looks something like this: set vendor-string = "SUNW.Ultra-5_10"; The vendor-class-identifier option is normally used by the DHCP server to determine the options that are returned in the vendor- encapsulated-options option. Please see the VENDOR ENCAPSULATED OPTIONS section later in this manual page for further information. option vendor-encapsulated-options string; The vendor-encapsulated-options option can contain either a single vendor-specific value or one or more vendor-specific suboptions. This option is not normally specified in the DHCP server configura- tion file - instead, a vendor class is defined for each vendor, ven- dor class suboptions are defined, values for those suboptions are defined, and the DHCP server makes up a response on that basis. Some default behaviours for well-known DHCP client vendors (cur- rently, the Microsoft Windows 2000 DHCP client) are configured auto- matically, but otherwise this must be configured manually - see the VENDOR ENCAPSULATED OPTIONS section later in this manual page for details. option vivso string; The vivso option can contain multiple separate options, one for each 32-bit Enterprise ID. Each Enterprise-ID discriminated option then contains additional options whose format is defined by the vendor who holds that ID. This option is usually not configured manually, but rather is configured via intervening option definitions. Please also see the VENDOR ENCAPSULATED OPTIONS section later in this man- ual page for details. option www-server ip-address [, ip-address... ]; The WWW server option specifies a list of WWW servers available to the client. Servers should be listed in order of preference. option x-display-manager ip-address [, ip-address... ]; This option specifies a list of systems that are running the X Win- dow System Display Manager and are available to the client. Addresses should be listed in order of preference. RELAY AGENT INFORMATION OPTION An IETF draft, draft-ietf-dhc-agent-options-11.txt, defines a series of encapsulated options that a relay agent can add to a DHCP packet when relaying it to the DHCP server. The server can then make address allocation decisions (or whatever other decisions it wants) based on these options. The server also returns these options in any replies it sends through the relay agent, so that the relay agent can use the information in these options for delivery or accounting purposes. The current draft defines two options. To reference these options in the dhcp server, specify the option space name, "agent", followed by a period, followed by the option name. It is not normally useful to define values for these options in the server, although it is permissi- ble. These options are not supported in the client. option agent.circuit-id string; The circuit-id suboption encodes an agent-local identifier of the circuit from which a DHCP client-to-server packet was received. It is intended for use by agents in relaying DHCP responses back to the proper circuit. The format of this option is currently defined to be vendor-dependent, and will probably remain that way, although the current draft allows for for the possibility of standardizing the format in the future. option agent.remote-id string; The remote-id suboption encodes information about the remote host end of a circuit. Examples of what it might contain include caller ID information, username information, remote ATM address, cable modem ID, and similar things. In principal, the meaning is not well-specified, and it should generally be assumed to be an opaque object that is administratively guaranteed to be unique to a partic- ular remote end of a circuit. option agent.DOCSIS-device-class uint32; The DOCSIS-device-class suboption is intended to convey information about the host endpoint, hardware, and software, that either the host operating system or the DHCP server may not otherwise be aware of (but the relay is able to distinguish). This is implemented as a 32-bit field (4 octets), each bit representing a flag describing the host in one of these ways. So far, only bit zero (being the least significant bit) is defined in RFC3256. If this bit is set to one, the host is considered a CPE Controlled Cable Modem (CCCM). All other bits are reserved. option agent.link-selection ip-address; The link-selection suboption is provided by relay agents to inform servers what subnet the client is actually attached to. This is useful in those cases where the giaddr (where responses must be sent to the relay agent) is not on the same subnet as the client. When this option is present in a packet from a relay agent, the DHCP server will use its contents to find a subnet declared in configura- tion, and from here take one step further backwards to any shared- network the subnet may be defined within...the client may be given any address within that shared network, as normally appropriate. THE CLIENT FQDN SUBOPTIONS The Client FQDN option, currently defined in the Internet Draft draft- ietf-dhc-fqdn-option-00.txt is not a standard yet, but is in suffi- ciently wide use already that we have implemented it. Due to the com- plexity of the option format, we have implemented it as a suboption space rather than a single option. In general this option should not be configured by the user - instead it should be used as part of an automatic DNS update system. option fqdn.no-client-update flag; When the client sends this, if it is true, it means the client will not attempt to update its A record. When sent by the server to the client, it means that the client should not update its own A record. option fqdn.server-update flag; When the client sends this to the server, it is requesting that the server update its A record. When sent by the server, it means that the server has updated (or is about to update) the client’s A record. option fqdn.encoded flag; If true, this indicates that the domain name included in the option is encoded in DNS wire format, rather than as plain ASCII text. The client normally sets this to false if it doesn’t support DNS wire format in the FQDN option. The server should always send back the same value that the client sent. When this value is set on the configuration side, it controls the format in which the fqdn.fqdn suboption is encoded. option fqdn.rcode1 flag; option fqdn.rcode2 flag; These options specify the result of the updates of the A and PTR records, respectively, and are only sent by the DHCP server to the DHCP client. The values of these fields are those defined in the DNS protocol specification. option fqdn.fqdn text; Specifies the domain name that the client wishes to use. This can be a fully-qualified domain name, or a single label. If there is no trailing generally update that name in some locally-defined domain. option fqdn.hostname --never set--; This option should never be set, but it can be read back using the option and config-option operators in an expression, in which case it returns the first label in the fqdn.fqdn suboption - for example, if the value of fqdn.fqdn is "foo.example.com.", then fqdn.hostname will be "foo". option fqdn.domainname --never set--; This option should never be set, but it can be read back using the option and config-option operators in an expression, in which case it returns all labels after the first label in the fqdn.fqdn subop- tion - for example, if the value of fqdn.fqdn is "foo.example.com.", then fqdn.hostname will be "example.com.". If this suboption value is not set, it means that an unqualified name was sent in the fqdn option, or that no fqdn option was sent at all. If you wish to use any of these suboptions, we strongly recommend that you refer to the Client FQDN option draft (or standard, when it becomes a standard) - the documentation here is sketchy and incomplete in com- parison, and is just intended for reference by people who already understand the Client FQDN option specification. THE NETWARE/IP SUBOPTIONS RFC2242 defines a set of encapsulated options for Novell NetWare/IP clients. To use these options in the dhcp server, specify the option space name, "nwip", followed by a period, followed by the option name. The following options can be specified: option nwip.nsq-broadcast flag; If true, the client should use the NetWare Nearest Server Query to locate a NetWare/IP server. The behaviour of the Novell client if this suboption is false, or is not present, is not specified. option nwip.preferred-dss ip-address [, ip-address... ]; This suboption specifies a list of up to five IP addresses, each of which should be the IP address of a NetWare Domain SAP/RIP server (DSS). option nwip.nearest-nwip-server ip-address [, ip-address...]; This suboption specifies a list of up to five IP addresses, each of which should be the IP address of a Nearest NetWare IP server. option nwip.autoretries uint8; Specifies the number of times that a NetWare/IP client should attempt to communicate with a given DSS server at startup. option nwip.autoretry-secs uint8; Specifies the number of seconds that a Netware/IP client should wait between retries when attempting to establish communications with a DSS server at startup. option nwip.nwip-1-1 uint8; If true, the NetWare/IP client should support NetWare/IP version 1.1 compatibility. This is only needed if the client will be contact- ing Netware/IP version 1.1 servers. option nwip.primary-dss ip-address; Specifies the IP address of the Primary Domain SAP/RIP Service server (DSS) for this NetWare/IP domain. The NetWare/IP adminis- tration utility uses this value as Primary DSS server when configur- ing a secondary DSS server. STANDARD DHCPV6 OPTIONS DHCPv6 options differ from DHCPv4 options partially due to using 16-bit code and length tags, but semantically zero-length options are legal in DHCPv6, and multiple options are treated differently. Whereas in DHCPv4 multiple options would be concatenated to form one option, in DHCPv6 they are expected to be individual instantiations. Understand- ably, many options are not "allowed" to have multiple instances in a packet - normally these are options which are digested by the DHCP pro- tocol software, and not by users or applications. option dhcp6.client-id string; This option specifies the client’s DUID identifier. DUIDs are simi- lar but different from DHCPv4 client identifiers - there are docu- mented duid types: duid-llt duid-en duid-ll This value should not be configured, but rather is provided by clients and treated as an opaque identifier key blob by servers. option dhcp6.server-id string; This option specifies the server’s DUID identifier. One may use this option to configure an opaque binary blob for your server’s identifier. option dhcp6.ia-na string; The Identity Association for Non-temporary Addresses (ia-na) carries assigned addresses that are not temporary addresses for use by the DHCPv6 client. This option is produced by the DHCPv6 server soft- ware, and should not be configured. option dhcp6.ia-ta string; The Identity Association for Temporary Addresses (ia-ta) carries temporary addresses, which may change upon every renewal. There is no support for this in the current DHCPv6 software. option dhcp6.ia-addr string; The Identity Association Address option is encapsulated inside ia-na or ia-ta options in order to represent addresses associated with those IA’s. These options are manufactured by the software, so should not be configured. option dhcp6.oro uint16 [ , uint16, ... ]; The Option Request Option ("ORO") is the DHCPv6 equivalent of the parameter-request-list. Clients supply this option to ask servers to reply with options relevant to their needs and use. This option must not be directly configured, the request syntax in dhclient.conf (5) should be used instead. option dhcp6.preference uint8; The preference option informs a DHCPv6 client which server is applied during the initial stages of configuration - once a client is bound to an IA, it will remain bound to that IA until it is no longer valid or has expired. This value may be configured on the server, and is digested by the client software. option dhcp6.elapsed-time uint16; The elapsed-time option is constructed by the DHCPv6 client soft- ware, and is potentially consumed by intermediaries. This option should not be configured. option dhcp6.relay-msg string; The relay-msg option is constructed by intervening DHCPv6 relay agent software. This option is entirely used by protocol software, and is not meant for user configuration. option dhcp6.unicast ip6-address; The unicast option is provided by DHCPv6 servers which are willing (or prefer) to receive Renew packets from their clients by exchang- ing UDP unicasts with them. Normally, DHCPv6 clients will multicast their Renew messages. This may be configured on the server, and should be configured as an address the server is ready to reply to. option dhcp6.status-code status-code [ string ] ; The status-code option is provided by DHCPv6 servers to inform clients of error conditions during protocol communication. This option is manufactured and digested by protocol software, and should not be configured. option dhcp6.rapid-commit ; The rapid-commit option is a zero-length option that clients use to indicate their desire to enter into rapid-commit with the server. This option is not supported by the client at this time, and is digested by the server when present, so should not be configured. option dhcp6.vendor-opts string; The vendor-opts option is actually an encapsulated sub-option space, in which each Vendor-specific Information Option (VSIO) is identi- fied by a 32-bit Enterprise-ID number. The encapsulated option spaces within these options are defined by the vendors. To make use of this option, the best way is to examine the section titled VENDOR ENCAPSULATED OPTIONS below, in particular the bits about the "vsio" option space. option dhcp6.interface-id string; The interface-id option is manufactured by relay agents, and may be used to guide configuration differentiating clients by the interface they are remotely attached to. It does not make sense to configure a value for this option, but it may make sense to inspect its con- tents. option dhcp6.reconf-msg dhcpv6-message; The reconf-msg option is manufactured by servers, and sent to clients in Reconfigure messages to inform them of what message the client should Reconfigure using. There is no support for DHCPv6 Reconfigure extensions, and this option is documented information- ally only. option dhcp6.reconf-accept ; The reconf-accept option is included by DHCPv6 clients that support the Reconfigure extentions, advertising that they will respond if the server were to ask them to Reconfigure. There is no support for DHCPv6 Reconfigure extensions, and this option is documented infor- mationally only. option dhcp6.sip-servers-names domain-list; The sip-servers-names option allows SIP clients to locate a local SIP server that is to be used for all outbound SIP requests, a so- called"outbound proxy server." If you wish to use manually entered IPv6 addresses instead, please see the sip-servers-addresses option below. option dhcp6.sip-servers-addresses ip6-address [, ip6-address ... ] ; The sip-servers-addresses option allows SIP clients to locate a local SIP server that is to be used for all outbound SIP requests, a so-called "outbound proxy servers." If you wish to use domain names rather than IPv6 addresses, please see the sip-servers-names option above. option dhcp6.name-servers ip6-address [, ip6-address ... ] ; The name-servers option instructs clients about locally available recursive DNS servers. It is easiest to describe this as the "name- server" line in /etc/resolv.conf. option dhcp6.domain-search domain-list; The domain-search option specifies the client’s domain search path to be applied to recursive DNS queries. It is easiest to describe this as the "search" line in /etc/resolv.conf. option dhcp6.ia-pd string; The ia-pd option is manufactured by clients and servers to create a Prefix Delegation binding - to delegate an IPv6 prefix to the client. There is not yet any support for prefix delegation in this software, and this option is provided informationally only. option dhcp6.ia-prefix string; The ia-prefix option is placed inside ia-pd options in order to identify the prefix(es) allocated to the client. There is not yet any suport for prefix delegation in this software, and this option is provided informationally only. option dhcp6.nis-servers ip6-address [, ip6-address ... ] ; The nis-servers option identifies, in order, NIS servers available to the client. option dhcp6.nisp-servers ip6-address [, ip6-address ... ] ; The nisp-servers option identifies, in order, NIS+ servers available to the client. option nis-domain-name domain-list; The nis-domain-name option specifies the NIS domain name the client is expected to use, and is related to the nis-servers option. option nisp-domain-name domain-list; The nisp-domain-name option specifies the NIS+ domain name the client is expected to use, and is related to the nisp-servers option. option dhcp6.sntp-servers ip6-address [, ip6-address ... ] ; The sntp-servers option specifies a list of local SNTP servers available for the client to synchronize their clocks. option dhcp6.info-refresh-time uint32; The info-refresh-time option gives DHCPv6 clients using Information- request messages a hint as to how long they should between refresh- ing the information they were given. Note that this option will only be delivered to the client, and be likely to affect the client’s behaviour, if the client requested the option. option dhcp6.bcms-server-d domain-list; The bcms-server-d option contains the domain names of local BCMS (Broadcast and Multicast Control Services) controllers which the client may use. option dhcp6.bcms-server-a ip6-address [, ip6-address ... ] ; The bcms-server-a option contains the IPv6 addresses of local BCMS (Broadcast and Multicast Control Services) controllers which the client may use. option dhcp6.remote-id string; The remote-id option is constructed by relay agents, to inform the server of details pertaining to what the relay knows about the client (such as what port it is attached to, and so forth). The contents of this option have some vendor-specific structure (similar to VSIO), but we have chosen to treat this option as an opaque field. option dhcp6.subscriber-id; The subscriber-id option is an opaque field provided by the relay agent, which provides additional information about the subscriber in question. The exact contents of this option depend upon the vendor and/or the operator’s configuration of the remote device, and as such is an opaque field. option dhcp6.fqdn string; The fqdn option is normally constructed by the client or server, and negotiates the client’s Fully Qualified Domain Name, as well as which party is responsible for Dynamic DNS Updates. See the section on the Client FQDN SubOptions for full details (the DHCPv4 and DHCPv6 FQDN options use the same "fqdn." encapsulated space, so are in all ways identical). option dhcp6.lq-query string; The lq-query option is used internally by for lease query. option dhcp6.client-data string; The client-data option is used internally by for lease query. option dhcp6.clt-time uint32; The clt-time option is used internally by for lease query. option dhcp6.lq-relay-data ip6-address string; The lq-relay-data option is used internally by for lease query. option dhcp6.lq-client-link ip6-address [, ip6-address ... ] ; The lq-client-link option is used internally by for lease query. option dhcp6.bootfile-url string ; The server sends this option to inform the client about a URL to a boot file. Used primarily for UEFI network booting, it contains an RFC3986 compliant URI which the client may use to boot an operating system. This option is defined in RFC5970 option dhcp6.arch-type arch-id [, arch-id...] ; A client will send this option to a server so that the server may make decisions on what options and addresses to offer the requesting client. The option consists of a list of 16 bit unsigned values that represent the architecture of the requesting client. These values corespond to the values available to the dhcpv4 option archi- tecture-type, as defined in RFC4578, section 2.1. This option is defined in RFC5970 option dhcp6.net-id uint8 uint8 uint8 ; A client will send this option to a server to inform it about the clients level of UNDI support. The option consists of 3 octets (a type, major and minor value). Specific meanings of these values are doumented in section 2.2 of RFC4578. This option is defined in RFC5970 DEFINING NEW OPTIONS The Internet Systems Consortium DHCP client and server provide the capability to define new options. Each DHCP option has a name, a code, and a structure. The name is used by you to refer to the option. The code is a number, used by the DHCP server and client to refer to an option. The structure describes what the contents of an option looks like. To define a new option, you need to choose a name for it that is not in use for some other option - for example, you can’t use "host-name" because the DHCP protocol already defines a host-name option, which is documented earlier in this manual page. If an option name doesn’t appear in this manual page, you can use it, but it’s probably a good idea to put some kind of unique string at the beginning so you can be sure that future options don’t take your name. For example, you might define an option, "local-host-name", feeling some confidence that no official DHCP option name will ever start with "local". Once you have chosen a name, you must choose a code. All codes between 224 and 254 are reserved as ’site-local’ DHCP options, so you can pick any one of these for your site (not for your product/application). In RFC3942, site-local space was moved from starting at 128 to starting at 224. In practice, some vendors have interpreted the protocol rather loosely and have used option code values greater than 128 themselves. There’s no real way to avoid this problem, and it was thought to be unlikely to cause too much trouble in practice. If you come across a vendor-documented option code in either the new or old site-local spaces, please contact your vendor and inform them about rfc3942. The structure of an option is simply the format in which the option data appears. The ISC DHCP server currently supports a few simple types, like integers, booleans, strings and IP addresses, and it also supports the ability to define arrays of single types or arrays of fixed sequences of types. New options are declared as follows: option new-name code new-code = definition ; The values of new-name and new-code should be the name you have chosen for the new option and the code you have chosen. The definition should be the definition of the structure of the option. The following simple option type definitions are supported: BOOLEAN option new-name code new-code = boolean ; An option of type boolean is a flag with a value of either on or off (or true or false). So an example use of the boolean type would be: option use-zephyr code 180 = boolean; option use-zephyr on; INTEGER option new-name code new-code = sign integer width ; The sign token should either be blank, unsigned or signed. The width can be either 8, 16 or 32, and refers to the number of bits in the integer. So for example, the following two lines show a definition of the sql-connection-max option and its use: option sql-connection-max code 192 = unsigned integer 16; option sql-connection-max 1536; IP-ADDRESS option new-name code new-code = ip-address ; An option whose structure is an IP address can be expressed either as a domain name or as a dotted quad. So the following is an example use of the ip-address type: option sql-server-address code 193 = ip-address; option sql-server-address sql.example.com; IP6-ADDRESS option new-name code new-code = ip6-address ; An option whose structure is an IPv6 address must be expressed as a valid IPv6 address. The following is an example use of the ip6-address type: option dhcp6.some-server code 1234 = array of ip6-address; option dhcp6.some-server 3ffe:bbbb:aaaa:aaaa::1, 3ffe:bbbb:aaaa:aaaa::2; TEXT option new-name code new-code = text ; An option whose type is text will encode an ASCII text string. For example: option sql-default-connection-name code 194 = text; option sql-default-connection-name "PRODZA"; DATA STRING option new-name code new-code = string ; An option whose type is a data string is essentially just a collection of bytes, and can be specified either as quoted text, like the text type, or as a list of hexadecimal contents separated by colons whose values must be between 0 and FF. For example: option sql-identification-token code 195 = string; option sql-identification-token 17:23:19:a6:42:ea:99:7c:22; DOMAIN-LIST option new-name code new-code = domain-list [compressed] ; An option whose type is domain-list is an RFC1035 formatted (on the wire, "DNS Format") list of domain names, separated by root labels. The optional compressed keyword indicates if the option should be com- pressed relative to the start of the option contents (not the packet contents). When in doubt, omit the compressed keyword. When the software recieves an option that is compressed and the compressed keyword is omitted, it will still decompress the option (relative to the option contents field). The keyword only controls whether or not transmitted packets are compressed. Note that when domain-list formatted options are output as environment variables to dhclient-script(8), the standard DNS -escape mechanism is used: they are decimal. This is appropriate for direct use in eg /etc/resolv.conf. ENCAPSULATION option new-name code new-code = encapsulate identifier ; An option whose type is encapsulate will encapsulate the contents of the option space specified in identifier. Examples of encapsulated options in the DHCP protocol as it currently exists include the vendor- encapsulated-options option, the netware-suboptions option and the relay-agent-information option. option space local; option local.demo code 1 = text; option local-encapsulation code 197 = encapsulate local; option local.demo "demo"; ARRAYS Options can contain arrays of any of the above types except for the text and data string types, which aren’t currently supported in arrays. An example of an array definition is as follows: option kerberos-servers code 200 = array of ip-address; option kerberos-servers 10.20.10.1, 10.20.11.1; RECORDS Options can also contain data structures consisting of a sequence of data types, which is sometimes called a record type. For example: option contrived-001 code 201 = { boolean, integer 32, text }; option contrived-001 on 1772 "contrivance"; It’s also possible to have options that are arrays of records, for example: option new-static-routes code 201 = array of { ip-address, ip-address, ip-address, integer 8 }; option static-routes 10.0.0.0 255.255.255.0 net-0-rtr.example.com 1, 10.0.1.0 255.255.255.0 net-1-rtr.example.com 1, 10.2.0.0 255.255.224.0 net-2-0-rtr.example.com 3; VENDOR ENCAPSULATED OPTIONS The DHCP protocol defines the vendor-encapsulated-options option, which allows vendors to define their own options that will be sent encapsu- lated in a standard DHCP option. It also defines the Vendor Identified Vendor Sub Options option ("VIVSO"), and the DHCPv6 protocol defines the Vendor-specific Information Option ("VSIO"). The format of all of these options is usually internally a string of options, similarly to other normal DHCP options. The VIVSO and VSIO options differ in that that they contain options that correspond to vendor Enterprise-ID num- bers (assigned by IANA), which then contain options according to each Vendor’s specifications. You will need to refer to your vendor’s docu- mentation in order to form options to their specification. The value of these options can be set in one of two ways. The first way is to simply specify the data directly, using a text string or a colon-separated list of hexadecimal values. For help in forming these strings, please refer to RFC2132 for the DHCPv4 Vendor Specific Infor- mation Option, RFC3925 for the DHCPv4 Vendor Identified Vendor Sub Options, or RFC3315 for the DHCPv6 Vendor-specific Information Option. For example: option vendor-encapsulated-options 2:4: AC:11:41:1: 3:12: 73:75:6e:64:68:63:70:2d:73:65:72:76:65:72:31:37:2d:31: 4:12: 2f:65:78:70:6f:72:74:2f:72:6f:6f:74:2f:69:38:36:70:63; option vivso 00:00:09:bf:0E: 01:0c: 48:65:6c:6c:6f:20:77:6f:72:6c:64:21; option dhcp6.vendor-opts 00:00:09:bf: 00:01:00:0c: 48:65:6c:6c:6f:20:77:6f:72:6c:64:21; The second way of setting the value of these options is to have the DHCP server generate a vendor-specific option buffer. To do this, you must do four things: define an option space, define some options in that option space, provide values for them, and specify that that option space should be used to generate the relevant option. To define a new option space in which vendor options can be stored, use the option space statement: option space name [ [ code width number ] [ length width number ] [ hash size number ] ] ; Where the numbers following code width, length width, and hash size respectively identify the number of bytes used to describe option codes, option lengths, and the size in buckets of the hash tables to hold options in this space (most DHCPv4 option spaces use 1 byte codes and lengths, which is the default, whereas most DHCPv6 option spaces use 2 byte codes and lengths). The code and length widths are used in DHCP protocol - you must config- ure these numbers to match the applicable option space you are config- uring. They each default to 1. Valid values for code widths are 1, 2 or 4. Valid values for length widths are 0, 1 or 2. Most DHCPv4 option spaces use 1 byte codes and lengths, which is the default, whereas most DHCPv6 option spaces use 2 byte codes and lengths. A zero-byte length produces options similar to the DHCPv6 Vendor-specific Information Option - but not their contents! The hash size defaults depend upon the code width selected, and may be 254 or 1009. Valid values range between 1 and 65535. Note that the higher you configure this value, the more memory will be used. It is considered good practice to configure a value that is slightly larger than the estimated number of options you plan to configure within the space. Previous versions of ISC DHCP (up to and including DHCP 3.0.*), this value was fixed at 9973. The name can then be used in option definitions, as described earlier in this document. For example: option space SUNW code width 1 length width 1 hash size 3; option SUNW.server-address code 2 = ip-address; option SUNW.server-name code 3 = text; option SUNW.root-path code 4 = text; option space ISC code width 1 length width 1 hash size 3; option ISC.sample code 1 = text; option vendor.ISC code 2495 = encapsulate vivso-sample; option vendor-class.ISC code 2495 = text; option ISC.sample "configuration text here"; option vendor-class.ISC "vendor class here"; option space docsis code width 2 length width 2 hash size 17; option docsis.tftp-servers code 32 = array of ip6-address; option docsis.cablelabs-configuration-file code 33 = text; option docsis.cablelabs-syslog-servers code 34 = array of ip6-address; option docsis.device-id code 36 = string; option docsis.time-servers code 37 = array of ip6-address; option docsis.time-offset code 38 = signed integer 32; option vsio.docsis code 4491 = encapsulate docsis; Once you have defined an option space and the format of some options, you can set up scopes that define values for those options, and you can say when to use them. For example, suppose you want to handle two different classes of clients. Using the option space definition shown in the previous example, you can send different option values to dif- ferent clients based on the vendor-class-identifier option that the clients send, as follows: class "vendor-classes" { match option vendor-class-identifier; } subclass "vendor-classes" "SUNW.Ultra-5_10" { vendor-option-space SUNW; option SUNW.root-path "/export/root/sparc"; } subclass "vendor-classes" "SUNW.i86pc" { vendor-option-space SUNW; option SUNW.root-path "/export/root/i86pc"; } option SUNW.server-address 172.17.65.1; option SUNW.server-name "sundhcp-server17-1"; option vivso-sample.sample "Hello world!"; option docsis.tftp-servers ::1; As you can see in the preceding example, regular scoping rules apply, so you can define values that are global in the global scope, and only define values that are specific to a particular class in the local scope. The vendor-option-space declaration tells the DHCP server to use options in the SUNW option space to construct the DHCPv4 vendor- encapsulated-options option. This is a limitation of that option - the DHCPv4 VIVSO and the DHCPv6 VSIO options can have multiple vendor defi- nitions all at once (even transmitted to the same client), so it is not necessary to configure this. SEE ALSO dhcpd.conf(5), dhcpd.leases(5), dhclient.conf(5), dhcp-eval(5), dhcpd(8), dhclient(8), RFC2132, RFC2131, RFC3046, RFC3315. AUTHOR The Internet Systems Consortium DHCP Distribution was written by Ted Lemon under a contract with Vixie Labs. Funding for this project was provided through Internet Systems Consortium. Information about Inter- net Systems Consortium can be found at https://www.isc.org. dhcpd-options(5)
Copyright(C) linux-cmd.com All Rights Reserved. Author Takayuki Yukawa