jc/docs/parsers/route.md

jc.parsers.route

jc - JSON CLI output utility route command output parser

Usage (cli):

$ route | jc --route

or

$ jc route

Usage (module):

import jc.parsers.route
result = jc.parsers.route.parse(route_command_output)

Compatibility:

'linux'

Examples:

$ route -ee | jc --route -p
[
  {
    "destination": "default",
    "gateway": "_gateway",
    "genmask": "0.0.0.0",
    "flags": "UG",
    "metric": 202,
    "ref": 0,
    "use": 0,
    "iface": "ens33",
    "mss": 0,
    "window": 0,
    "irtt": 0,
    "flags_pretty": [
      "UP",
      "GATEWAY"
    ]
  },
  {
    "destination": "192.168.71.0",
    "gateway": "0.0.0.0",
    "genmask": "255.255.255.0",
    "flags": "U",
    "metric": 202,
    "ref": 0,
    "use": 0,
    "iface": "ens33",
    "mss": 0,
    "window": 0,
    "irtt": 0,
    "flags_pretty": [
      "UP"
    ]
  }
]


$ route -ee | jc --route -p -r
[
  {
    "destination": "default",
    "gateway": "_gateway",
    "genmask": "0.0.0.0",
    "flags": "UG",
    "metric": "202",
    "ref": "0",
    "use": "0",
    "iface": "ens33",
    "mss": "0",
    "window": "0",
    "irtt": "0"
  },
  {
    "destination": "192.168.71.0",
    "gateway": "0.0.0.0",
    "genmask": "255.255.255.0",
    "flags": "U",
    "metric": "202",
    "ref": "0",
    "use": "0",
    "iface": "ens33",
    "mss": "0",
    "window": "0",
    "irtt": "0"
  }
]

info

info()

process

process(proc_data)

Final processing to conform to the schema.

Parameters:

proc_data:   (List of Dictionaries) raw structured data to process

Returns:

List of Dictionaries. Structured data with the following schema:

[
  {
    "destination":     string,
    "gateway":         string,
    "genmask":         string,
    "flags":           string,
    "flags_pretty": [
                       string,
    ]
    "metric":          integer,
    "ref":             integer,
    "use":             integer,
    "mss":             integer,
    "window":          integer,
    "irtt":            integer,
    "iface":           string
  }
]

parse

parse(data, raw=False, quiet=False)

Main text parsing function

Parameters:

data:        (string)  text data to parse
raw:         (boolean) output preprocessed JSON if True
quiet:       (boolean) suppress warning messages if True

Returns:

List of Dictionaries. Raw or processed structured data.