JSON・YAMLとは何か

たとえば、ネットワーク機器の情報として次の3項目を扱うとします。

• ホスト名：RTR01
• 管理IPアドレス：192.168.10.1
• 状態：up

人間が文章で書けば、 「RTR01の管理IPアドレスは192.168.10.1で、状態はupです」 と表現できます。

しかし、自動化プログラムでは、 どこがホスト名で、どこがIPアドレスなのか を明確に区別できなければなりません。

JSONで表現すると

{
  "hostname": "RTR01",
  "management_ip": "192.168.10.1",
  "status": "up"
}

YAMLで表現すると

hostname: RTR01
management_ip: 192.168.10.1
status: up

見た目は違いますが、 どちらも表している内容は同じです。

なぜネットワークエンジニアにJSON・YAMLが必要なのか

CLIだけでネットワーク機器を管理していると、 JSONやYAMLを見る機会はそれほど多くありません。

しかし、自動化やAPIを使い始めると、 設定値や取得結果を 構造化されたデータ として扱う場面が増えます。

JSONの読み方

JSONを読むときは、 すべての記号を一度に理解しようとする必要はありません。

最初は次の4点を確認します。

1. { } はまとまりを表す
2. "キー": 値 の組み合わせを探す
3. [ ] は複数の値が並ぶ配列
4. 入れ子になっている場合は外側から内側へ読む

基本となる「キー」と「値」

{
  "hostname": "SW01",
  "ip_address": "192.168.1.10",
  "port_count": 48,
  "enabled": true
}

JSONでよく使う値

配列を読む

{
  "vlans": [
    10,
    20,
    30
  ]
}

vlansというキーに対し、 VLAN 10、20、30の3つの値が格納されています。

YAMLの読み方

YAMLではJSONのように波括弧を大量に使用せず、 改行とインデントによって階層を表現します。

hostname: SW01
management_ip: 192.168.1.10
enabled: true

基本形は非常にシンプルです。

キー: 値

インデントで階層を表す

device:
  hostname: SW01
  management_ip: 192.168.1.10

この例では、deviceの下に hostnameとmanagement_ipがあります。

左端の位置を見ることで、 どのデータがどの階層に所属しているか判断できます。

ハイフンはリストを表す

vlans:
  - 10
  - 20
  - 30

-で始まる行は、 複数の項目を並べたリストとして読むことができます。

複数の機器を表す例

devices:
  - hostname: SW01
    ip_address: 192.168.1.10
  - hostname: SW02
    ip_address: 192.168.1.11

devicesの下に、 SW01とSW02という2台分のデータがあります。

JSONとYAMLの違い

同じデータを比較する

{
  "hostname": "R1",
  "interfaces": [
    "GigabitEthernet0/0",
    "GigabitEthernet0/1"
  ]
}

hostname: R1
interfaces:
  - GigabitEthernet0/0
  - GigabitEthernet0/1

表現方法は違いますが、 どちらも「R1には2つのインターフェースがある」 という同じ構造を表しています。

ネストされたデータの読み方

JSONやYAMLで初心者がつまずきやすいのが、 データの中にさらにデータが入る ネストです。

{
  "device": {
    "hostname": "R1",
    "interfaces": [
      {
        "name": "GigabitEthernet0/0",
        "ip_address": "192.168.10.1",
        "status": "up"
      },
      {
        "name": "GigabitEthernet0/1",
        "ip_address": "192.168.20.1",
        "status": "down"
      }
    ]
  }
}

一度に全部読もうとすると複雑に見えます。 外側から順番に分解します。

1. 最上位にdeviceがある
2. deviceの中にhostnameとinterfacesがある
3. interfacesは配列になっている
4. 配列には2つのインターフェース情報がある
5. それぞれにname・ip_address・statusがある

ネットワーク自動化での実例

例1：REST APIのレスポンスを読む

APIから次のような情報が返ったとします。

{
  "hostname": "CORE-SW01",
  "management_ip": "10.0.0.10",
  "interfaces": [
    {
      "name": "GigabitEthernet1/0/1",
      "status": "up"
    },
    {
      "name": "GigabitEthernet1/0/2",
      "status": "down"
    }
  ]
}

「downしているインターフェースを確認したい」 という目的であれば、すべてを読む必要はありません。

interfacesを探し、その中にある statusを順番に確認します。

例2：Ansibleで使うYAMLを読む

---
- name: Configure VLAN
  hosts: switches
  gather_facts: false

  tasks:
    - name: Create VLAN 100
      cisco.ios.ios_vlans:
        config:
          - vlan_id: 100
            name: SALES

初めて見ると難しそうですが、 階層ごとに読むと意味を追えます。

例3：機器パラメータをYAMLで管理する

devices:
  - hostname: CORE-SW01
    management_ip: 10.0.0.10
    site: tokyo

  - hostname: CORE-SW02
    management_ip: 10.0.0.11
    site: tokyo

このようにネットワーク機器のパラメータを 構造化して管理しておけば、 PythonやAnsibleから読み込んで処理することもできます。

JSON・YAMLでよくあるミス

{
  "hostname": "R1"
  "ip_address": "192.168.1.1"
}

{
  "hostname": "R1",
  "ip_address": "192.168.1.1"
}

{
  'hostname': 'R1'
}

{
  "hostname": "R1",
  "ip_address": "192.168.1.1",
}

device:
  hostname: R1
   ip_address: 192.168.1.1

実務ではどうやってJSON・YAMLを読むのか

実務で大きなJSONレスポンスを受け取ったとき、 最初から最後まで一行ずつ読む方法は効率的ではありません。

JSONを読む順序

1. 何のデータなのか確認する
2. 欲しい情報のキー名を考える
3. そのキーを検索する
4. キーがどのオブジェクト・配列に属しているか確認する
5. 値とデータ型を確認する

たとえば、 「インターフェースの状態を確認したい」 のであれば、 interface、status、 stateなどの項目を探します。

YAMLを読む順序

1. 最上位のキーを確認する
2. インデントを見て階層を確認する
3. -があればリストとして読む
4. 変更対象となるキーと値を探す
5. 前後の階層を確認してから編集する

顧客・上司へJSON・YAMLをどう説明するか

技術に詳しくない相手へ、 「JSONとYAMLを使います」とだけ説明しても、 自動化によって何が良くなるのかは伝わりません。

技術者向けの説明

顧客・管理者向けの説明

重要なのは、 JSONやYAMLという技術名そのものではなく、 「データを構造化することで何が改善されるか」 を説明することです。

JSON・YAMLでよく見る英語表現

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