コンフィグの書式

コンフィグの記述ルールや書式凡例の読み方を説明します。

本装置のコンフィグは「パラメータ」の集りです。一つのパラメータは次の要素を含み、一行で記述します。
  1. キー
  2. 区切り文字（コロン":"）
  3. バリュー

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

次の例は三つのパラメータを設定したコンフィグの記述です。 
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.[].interface
インタフェースの条件
制約事項:
省略不可
any
全てのインタフェース
<Interface>
インタフェース名
  • ge[]|ge*
  • pppoe[]|pppoe*
  • ppp[]|ppp*
  • ipsec[]|ipsec*
  • tunnel[]|tunnel*
  • bridge[]|bridge*
  • vlan[]|vlan*
  • pppac[]|pppac*
filter.ipv4.[].protocol
プロトコルの条件
<Number>
プロトコル番号
範囲
0-255
<Keyword>
プロトコル名
候補
ip | tcp | udp | icmp | igmp | ah | esp
tcpudp
TCPとUDP
tcp-synonly
TCPの接続要求パケット
tcp-established
TCPのセッション確立済みパケット
any
任意のプロトコル
デフォルト値
any

キー

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

表 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」として扱います（文字列ではなく数値として扱います）。
  • コンフィグ上の記述順によらず、インデックス番号を数値として昇順ソート（最小値が先頭）した上で動作に反映します。
設定可能なエントリの個数はパラメータごとに上限があり、コンフィグパラメータリファレンスでは次のように示します。
キー 読み方
dhcp6.client.[]...
DHCPv6クライアントの設定
設定上限
4個
 DHCPv6クライアントのコンフィグエントリを4個まで設定できます。

ひとつの機能の構成に複数種のキーを含む場合は共通パートのみ示し、固有パートを "..." として省略しています。
dhcp6.client.[].prefix-delegation.[]...
Prefix Delegationの設定
設定上限
35個
 "[]" を複数含むキーの説明箇所では、最後の "[]" を置き換えるインデックス番号の個数上限を示します。

このキーの場合は最大4個のDHCPv6クライアント設定それぞれについて、Prefix Delegationの設定が35個まで設定できます。

注:
書式の解釈とは別に機能全体に係る上限が存在する場合は個別の注意書きとして記載します。

インタフェース名の記述

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

表 3. インタフェース名を含むキーの書式凡例（PPPoEインタフェース）
キー バリュー
interface.pppoe[0-1].id <String>
interface.pppoe[0-1].password <String>

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

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
機能の動作を指定する
 特に装飾のない文字列表記はシステムに定義された固定のキーワード文字列です。そのまま記述します。
  • キーワード毎に個別の意味を持ち、指定によって動作内容が変化します。
<...>
任意の値または候補から指定する
 "<>" で括られた文字列表記は、任意の数値や文字列、または固定のキーワード文字列の候補から記述します。入力時に"<>"記号は不要です。使用可能な文字や数値の範囲および候補は基本的に項目内に記載しますが、共通事項はバリュー名のリンク先に記載する場合があります。
  • 識別子や番号など、特定の動作に対して基準となる文字列や数値を与えます。
デフォルト値
システム既定の動作
 機能有効化時に、当該キーが設定されていない場合の動作を記載します。
  • キーワードまたは数値が記載される場合は、それが設定されたものとして動作します。
表 5. 入力範囲や候補の書式凡例に含む記号の意味
表記 意味
keyword-a | keyword-b | <varname> "|" で区切られたキーワードは選択肢です。いずれか一つを指定します。
0-9999 数値を"-"で繋いだ値は数値の下限と上限を示します。通常は正の整数を十進数で指定します。
[0-9] "[.....]" で括られた文字列表記は使用可能な文字種に制限があることを示します。[0-9]は整数のみ、[-.A-Za-z]はハイフン、ピリオド、および英大文字小文字が使用できることを示します。
[-.A-Za-z]
特殊文字の入力
バリューの文字列に以下の特殊文字を含める場合は、表に示すエスケープシーケンスを入力してください。
特殊文字 エスケープシーケンス
\（バックスラッシュまたは円マーク） \\
"（二重引用符） \"
|（バーティカルバー）※Shellコマンドインタフェースでの直接入力時のみ \|
空白 バリュー全体を二重引用符(" ")で括る
  • エスケープ文字としての\や"はバリューの文字数にカウントされません。

説明文中の省略表記

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

制約

機能を設定するにあたり特定の条件があるキーは同欄に記載ます。