Top

Category

[Enterprise SONiC] Verify JSON format of /etc/sonic/config_db.json in SONiC Follow

Avatar
Ken Ho
  • Updated

Example: Verify JSON format

Tested model & firmware version:

  • Switch model name:

       AS7326-56X

  • Edgecore SONiC version: 

202006.4

202012.2

Command: sonic-cfggen

#sonic-cfggen -j /etc/sonic/config_db.json --print-data

-j JSON : indicate json file name

--print-data : print all data

Restriction:

  • "sonic-cfggen" is for JSON format verificaton only. It's NOT for parameters verification. 

Example:

Wrong JSON format on the /etc/sonic/config_db.json

 1 {
 2   "DEVICE_METADATA": {
 3       "localhost": {
 4           "bgp_asn": "4200000002
 5           "docker_routing_config_mode": "split"
 6           "hostname": "sonic",
 7           "hwsku": "Accton-AS7326-56X",
 8           "mac": "04:f8:f8:6b:3e:91",
 9           "platform": "x86_64-accton_as7326_56x-r0",
 10          "type": "LeafRouter",
 11      }
 12      }
 13  },
 omitted...
}

Note: wrong format with red print

Step 1. Use "sonic-cfggen" command to verify /etc/sonic/config_db.json

admin@sonic:~$ sonic-cfggen -j /etc/sonic/config_db.json --print-data
Traceback (most recent call last):
File "/usr/local/bin/sonic-cfggen", line 434, in <module>
main()
File "/usr/local/bin/sonic-cfggen", line 329, in main
_process_json(args, data)
File "/usr/local/bin/sonic-cfggen", line 237, in _process_json
deep_update(data, FormatConverter.to_deserialized(json.load(stream)))
File "/usr/lib/python3.7/json/__init__.py", line 296, in load
parse_constant=parse_constant, object_pairs_hook=object_pairs_hook, **kw)
File "/usr/lib/python3.7/json/__init__.py", line 348, in loads
return _default_decoder.decode(s)
File "/usr/lib/python3.7/json/decoder.py", line 337, in decode
obj, end = self.raw_decode(s, idx=_w(s, 0).end())
File "/usr/lib/python3.7/json/decoder.py", line 353, in raw_decode
obj, end = self.scan_once(s, idx)
json.decoder.JSONDecodeError: Invalid control character at: line 4 column 34 (char 83)

Note: Get error.   It indicates which line of the file is incorrect. 

Step 2. Refer to JSON format  and correct the file.

Step 3. Use "sonic-cfggen" command to verify until no errors. 

admin@sonic:~$ sonic-cfggen -j /etc/sonic/config_db.json --print-data
{
    "DEVICE_METADATA": {
        "localhost": {
            "bgp_asn": "4200000002",
            "docker_routing_config_mode": "split",
            "hostname": "sonic",
            "hwsku": "Accton-AS7326-56X",
            "platform": "x86_64-accton_as7326_56x-r0",
            "mac": "04:f8:f8:6b:3e:91",
            "type": "LeafRouter"
        }
    },
    omitted…
}

 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.

Articles in this section

See more