コンフィグの書式

本装置のコンフィグは、「パラメータ」の集りです。一つのパラメータは、次の要素を含み、一行で記述します。

キー
区切り文字（コロン":"）
バリュー

また、一つの機能の動作を設定するための一連のパラメータを「エントリ」と呼び、エントリは後述するインデックス番号やインタフェース名によって識別されます。

次の例は三つのパラメータを設定したコンフィグの記述です。

interface.ge0.ipv4.address  : 192.168.0.1/24
route.ipv4.0.destination    : default
route.ipv4.0.gateway        : pppoe0

1行目はインタフェースを設定する一つのエントリです。
2行目から3行目は静的経路を設定する一つのエントリです。

注:

コンフィグ記述上の注意

コンフィグ内にキーの重複がある場合は、重複行が全てエラーになります。
キーの記述に空白を含めるとエラーになります。
未定義のキーが記述された行はエラーになります。
コンフィグ中にコメントは記述できません。
全角文字などマルチバイト文字は使用できません。
キー、及びバリューの前後に記述された空白は無視します。
空行（改行のみの行）は無視します。
キーのみでバリューが記述されていない行は無視します。
コロンが複数記述されている場合は、最も左側のコロンを区切りとして扱います。

パラメータの書式凡例

機能ごとに設定可能なパラメータの一覧を示すコンフィグパラメータリファレンスでは、コンフィグの書式を次のように記載しています。

表 1. IPv4パケットフィルタのパラメータ一覧（一部抜粋）
キー	バリュー	デフォルト値	制約	概要
`filter.ipv4.[].label`	<String>（1-32文字）	なし		フィルタを識別するためのラベル文字列
`filter.ipv4.[].action`	`pass \| block`	なし	省略不可	条件に一致したパケットの処理方法
`filter.ipv4.[].direction`	`in \| out \| inout \| redirect`	なし	省略不可	入出力方向の条件

キー

区切り文字（":"）の左側に記述する「キー」は各機能の設定項目に相当し、システムに定義済みの文字列で記述します。

表 2. キーの書式凡例に含む記号の意味
表記	意味
[]（例：filter.ipv4.[].action）	ピリオドに挟まれた空の"[]"はエントリのインデックス番号の記述箇所を示します。インデックス番号は8桁の任意の整数を指定できます。
[0-n]（例：interface.ipsec[0-63]）	数値範囲を含む"[0-n]"は主にインタフェース名の表現で使用しています。範囲内の整数を指定できます。

インデックス番号の記述

同一の機能で複数のエントリを設定可能な場合には、パラメータが所属するエントリを区別するためのインデックス番号をキー中に記述します。

キーにインデックス番号を含むパラメータの記述例を次に示します。

filter.ipv4.111.label      : filter-example1
filter.ipv4.111.direction  : in
filter.ipv4.111.action     : pass
filter.ipv4.222.label      : filter-example2
filter.ipv4.222.direction  : out
filter.ipv4.222.action     : block

"[]" をインデックス番号に置き換えて記述します。

注:

インデックス番号の書式の注意

インデックス番号は数字で記述します。8桁以内の正の数が使用でき、連番である必要はありません。また、「001」といった記述が可能ですが、処理上は「1」として扱います（文字列ではなく数値として扱います）。
コンフィグ上の記述順によらず、インデックス番号を数値として昇順ソート（最小値が先頭）した上で動作に反映します。
設定可能なエントリの個数はパラメータごとに上限があります。

インタフェース名の記述

インタフェース名はシステムに定義されており、複数個使用可能なインタフェースは"pppoe[0-1]"のようにインタフェースの番号を"[0-n]"の書式で示します。

表 3. インタフェース名を含むキーの書式凡例（PPPoEインタフェース）
キー	バリュー	デフォルト値	制約	概要
`interface.pppoe[0-1].id`	<String>（1-150文字）	なし	省略不可	認証ID
`interface.pppoe[0-1].password`	<String>（1-64文字）	なし		認証パスワード

キーにインタフェース名を含むパラメータの記述例を次に示します。

interface.pppoe0.id        : id001@example.jp
interface.pppoe0.password  : PassPhrase
interface.pppoe1.id        : id002@example.jp
interface.pppoe1.password  : PassWord

"[0-n]" を、使用するインタフェースの番号に置き換えて記述します。

注:

インタフェース名の書式の注意

使用可能な個数が1個のインタフェースは"wwan0"のように固定文字列で示します。
バリューとしてインタフェース名を記述する場合の書式も同様です。

バリュー

区切り文字（":"）の右側に記述する「バリュー」は設定項目に対する設定値に相当し、パラメータごとに定義された規則に従った文字列で記述します。

表 4. バリューの書式凡例に含む記号の意味
表記	意味
`keyword`	特に装飾のない文字列表記はシステムに定義された固定のキーワード文字列です。使用する場合はそのまま記述して下さい
`<value>`	"<>" で括られた表記に対しては任意の数値や文字列が記述できます。使用可能な文字や数値の範囲は、説明セクションやリンク先の凡例を参照下さい
`keyword1 \| keyword2 \| <value>`	"\|" で区切られた値は選択肢です。いずれか一つを使用できます
`0-9999`	数値を"-"で繋いだ値は、数値の下限と上限を示します。併記がない限り、正の整数を10進数で記述できます
`[0-9]`	"[.....]" で括られた表記は使用可能な文字種に制限があることを示します。[0-9]は整数のみ、[-.A-Za-z]はハイフン、ピリオド、および英大文字小文字が使用できることを示します。
`[-.A-Za-z]`

特殊文字の入力

バリューの文字列に以下の特殊文字を含める場合は、表に示すエスケープシーケンスを入力してください。

特殊文字	エスケープシーケンス
\（バックスラッシュまたは円マーク）	\\
"（二重引用符）	\"
\|（バーティカルバー）※コマンドインタフェースでの直接入力時のみ	\\|
空白	バリュー全体を二重引用符(" ")で括る

エスケープ文字としての\や"はバリューの文字数にカウントされません。

説明文中の省略表記

コンフィグパラメータについて説明するとき、キーの一部を省略し "..." に置き換えて表記する場合があります。実際のコンフィグでは省略できません。

例:: interface.pppoe0...; ...password; ...password : PassPhrase

制約

記述を省略できないキーは「制約」欄に「省略不可」と記載しています。また、設定にあたり特定の条件があるキーは同欄に条件を記載しています。

デフォルト値

コンフィグに記述されていないキーについては「デフォルト値」欄の値を使用します。