Pythonで設定ファイルを作るとは

例えば、3台のスイッチへ次のような管理用インターフェースを設定するとします。

基本的な設定内容は同じで、違うのは ホスト名やIPアドレスなど一部の値だけです。

このような構成は、Pythonによる設定生成と非常に相性がよいケースです。

なぜ設定ファイル生成を自動化するのか

手作業との違い

設定生成の全体像

Pythonで設定を作る処理は、大きく次の5段階に分けて考えると分かりやすくなります。

最初はExcelやパラメータシートを直接読み込む必要はありません。 Pythonの変数やリスト、辞書へ値を直接記述するところから始めます。

慣れてきたら、CSV、JSON、YAMLなどから入力データを読み込む構成へ発展させられます。

まず1台分の設定を作る

最初は、Pythonの文字列として設定を作ってみましょう。

config = """
hostname SW01
!
interface Vlan100
 ip address 192.168.100.11 255.255.255.0
 no shutdown
!
ip default-gateway 192.168.100.1
!
end
"""

print(config)

実行すると、変数configに保存した文字列がそのまま表示されます。

これだけでは、単にconfigをPythonへ貼り付けただけです。

自動化するには、 機器ごとに変更する部分を変数へ置き換えます。

変数を使って設定値を変更する

ホスト名、管理IPアドレス、デフォルトゲートウェイを変数として定義します。

hostname = "SW01"
management_ip = "192.168.100.11"
subnet_mask = "255.255.255.0"
default_gateway = "192.168.100.1"

config = f"""
hostname {hostname}
!
interface Vlan100
 ip address {management_ip} {subnet_mask}
 no shutdown
!
ip default-gateway {default_gateway}
!
end
"""

print(config)

文字列の先頭にfを付けると、 {hostname}や{management_ip}の部分へ 変数の値を埋め込めます。

変数化すると何が変わるのか

SW02を作りたい場合は、設定本文を編集するのではなく、 値だけ変更できます。

hostname = "SW02"
management_ip = "192.168.100.12"

共通設定を直接編集する回数を減らせることが、 設定生成を自動化する大きなメリットです。

for文で複数の設定を作る

次はVLANを複数作成してみます。

手作業では、次の設定をVLAN数だけ繰り返します。

vlan 10
 name SALES
!
vlan 20
 name ENGINEERING
!
vlan 30
 name SERVER
!

Pythonでは、VLAN情報をリストへ保存してfor文で繰り返せます。

vlans = [
    {"id": 10, "name": "SALES"},
    {"id": 20, "name": "ENGINEERING"},
    {"id": 30, "name": "SERVER"}
]

config = ""

for vlan in vlans:
    config += f"""vlan {vlan['id']}
 name {vlan['name']}
!
"""

print(config)

VLANを追加したい場合は、生成ロジックを変更する必要はありません。

{"id": 40, "name": "GUEST"}

をリストへ追加すれば、VLAN 40の設定も生成できます。

インターフェース設定にも応用できる

interfaces = [
    {
        "name": "GigabitEthernet1/0/1",
        "description": "PC-A",
        "vlan": 10
    },
    {
        "name": "GigabitEthernet1/0/2",
        "description": "PC-B",
        "vlan": 20
    }
]

config = ""

for interface in interfaces:
    config += f"""interface {interface['name']}
 description {interface['description']}
 switchport mode access
 switchport access vlan {interface['vlan']}
 spanning-tree portfast
!
"""

print(config)

このように、 同じ形式を何度も繰り返す設定はPythonで生成しやすい対象です。

辞書で機器情報を管理する

1台の機器には、ホスト名だけでなく多くの設定値があります。

そこで、関連する値をPythonの辞書にまとめます。

device = {
    "hostname": "SW01",
    "management_ip": "192.168.100.11",
    "subnet_mask": "255.255.255.0",
    "default_gateway": "192.168.100.1",
    "ntp_server": "192.168.200.10",
    "syslog_server": "192.168.200.20"
}

設定生成側では、次のように値を参照します。

config = f"""
hostname {device['hostname']}
!
interface Vlan100
 ip address {device['management_ip']} {device['subnet_mask']}
 no shutdown
!
ip default-gateway {device['default_gateway']}
!
ntp server {device['ntp_server']}
logging host {device['syslog_server']}
!
end
"""

print(config)

これで、 入力データと 設定生成ロジックが明確に分かれました。

複数機器の設定ファイルを生成する

ここから、より実務に近い形へ進みます。

SW01、SW02、SW03の3台分の情報をリストへ登録します。

devices = [
    {
        "hostname": "SW01",
        "management_ip": "192.168.100.11",
        "subnet_mask": "255.255.255.0",
        "default_gateway": "192.168.100.1"
    },
    {
        "hostname": "SW02",
        "management_ip": "192.168.100.12",
        "subnet_mask": "255.255.255.0",
        "default_gateway": "192.168.100.1"
    },
    {
        "hostname": "SW03",
        "management_ip": "192.168.100.13",
        "subnet_mask": "255.255.255.0",
        "default_gateway": "192.168.100.1"
    }
]

設定生成を関数にする

同じ処理を何度も使用する場合は、関数にまとめると管理しやすくなります。

def generate_config(device):
    config = f"""hostname {device['hostname']}
!
interface Vlan100
 ip address {device['management_ip']} {device['subnet_mask']}
 no shutdown
!
ip default-gateway {device['default_gateway']}
!
end
"""
    return config

ファイルへ保存する

Python標準ライブラリのpathlibを使って、 生成した文字列をファイルとして保存します。

from pathlib import Path

devices = [
    {
        "hostname": "SW01",
        "management_ip": "192.168.100.11",
        "subnet_mask": "255.255.255.0",
        "default_gateway": "192.168.100.1"
    },
    {
        "hostname": "SW02",
        "management_ip": "192.168.100.12",
        "subnet_mask": "255.255.255.0",
        "default_gateway": "192.168.100.1"
    },
    {
        "hostname": "SW03",
        "management_ip": "192.168.100.13",
        "subnet_mask": "255.255.255.0",
        "default_gateway": "192.168.100.1"
    }
]


def generate_config(device):
    return f"""hostname {device['hostname']}
!
interface Vlan100
 ip address {device['management_ip']} {device['subnet_mask']}
 no shutdown
!
ip default-gateway {device['default_gateway']}
!
end
"""


output_dir = Path("output")
output_dir.mkdir(exist_ok=True)

for device in devices:
    config = generate_config(device)

    file_path = output_dir / f"{device['hostname']}.txt"

    file_path.write_text(
        config,
        encoding="utf-8"
    )

    print(f"Created: {file_path}")

実行すると、次のようなファイルが作成されます。

SW02.txtの内容

機器が10台になっても100台になっても、 基本的な処理の考え方は変わりません。

設定生成で重要なチェック

Pythonがエラーなく動いたからといって、 生成されたネットワーク設定が正しいとは限りません。

自動化では、 「生成できた」と「正しい設定である」を分けて考える 必要があります。

1．入力データを確認する

• IPアドレスが重複していないか
• サブネットマスクが正しいか
• VLAN番号が設計と一致しているか
• インターフェース名が実機と一致しているか
• ホスト名が命名規則に沿っているか

2．生成後のconfigをレビューする

初めて作成した自動化スクリプトから、 いきなり実機へ設定投入するのは避けます。

1. 入力値を確認する パラメータシートや設計書との一致を確認します。
2. 設定ファイルを生成する Pythonでconfigをファイルへ出力します。
3. 差分・内容をレビューする 想定外のコマンドや不足がないか確認します。
4. 検証環境で試験する 可能であればラボ環境や検証機で動作を確認します。
5. 本番投入する 承認・バックアップ・切り戻し手順を準備して実施します。

3．IPアドレスをプログラムで確認する

前回学習したipaddressモジュールも利用できます。

import ipaddress

management_ip = "192.168.100.11"

try:
    ipaddress.ip_address(management_ip)
    print("IPアドレスの形式は正常です")

except ValueError:
    print("IPアドレスの形式が不正です")

このように、第52回で学んだ内容を設定生成へ組み込むことで、 入力ミスを事前に検出する処理へ発展させられます。

実務ではどのように使えるのか

例1．新拠点スイッチの初期config

拠点ごとに次の値だけが異なる場合があります。

• ホスト名
• 管理IPアドレス
• デフォルトゲートウェイ
• NTPサーバー
• Syslogサーバー
• SNMP設定

共通部分をテンプレート化すれば、 拠点ごとのパラメータからconfigを生成できます。

例2．大量のアクセスポート設定

数十ポートのdescriptionやVLANを設定する場合、 パラメータ一覧から自動生成できます。

例3．VLAN追加作業

複数スイッチへ同じVLANを追加する場合も、 対象機器やVLAN一覧をデータ化できます。

例4．更改案件のconfig作成

旧機器の設定をそのままコピーするのではなく、 新設計のパラメータをもとに 新機器用configを再生成する仕組みも作れます。

Pythonで設定ファイルを作るときのよくある失敗

顧客・上司への説明方法

自動化の説明で、 「Pythonでconfigを作れるようになりました」 だけでは、業務上の価値が伝わりにくい場合があります。

技術を工数・品質・リスクへ変換して説明します。

説明例

上級エンジニアでは、 自動化技術を使えるだけでなく、 なぜ自動化するのかを業務上の効果として説明できること が重要です。

設定自動化で使われる英語表現

ドキュメントで見かける表現

自分の言葉で説明する課題