diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index 19d87a38..928039b6 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -5,7 +5,7 @@ jc - JSON CLI output utility `ping` command output streaming parser Usage (cli): - $ ping | jc --ping_s + $ ping | jc --ping-s Usage (module): @@ -19,23 +19,47 @@ Usage (module): Schema: { - "ping": string, - "_meta": # This object only exists if using -q or quiet=True + "type": string, # 'reply', 'timeout', 'summary', etc. See `_error_type.type_map` for all options. + "source_ip": string, + "destination_ip": string, + "sent_bytes": integer, + "pattern": string, # (null if not set) + "destination": string, + "timestamp": float, + "response_bytes": integer, + "response_ip": string, + "icmp_seq": integer, + "ttl": integer, + "time_ms": float, + "duplicate": boolean, + "packets_transmitted": integer, + "packets_received": integer, + "packet_loss_percent": float, + "duplicates": integer, + "round_trip_ms_min": float, + "round_trip_ms_avg": float, + "round_trip_ms_max": float, + "round_trip_ms_stddev": float, + "_meta": # This object only exists if using -q or quiet=True { - "success": booean, # true if successfully parsed, false if error - "error": string, # exists if "success" is false - "line": string # exists if "success" is false + "success": booean, # true if successfully parsed, false if error + "error": string, # exists if "success" is false + "line": string # exists if "success" is false } } Examples: - $ ping | jc --ping-s - {example output} + $ ping 1.1.1.1 | jc --ping-s + {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":0,"ttl":56,"time_ms":23.703} + {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":1,"ttl":56,"time_ms":22.862} + {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":2,"ttl":56,"time_ms":22.82} ... - $ ping | jc --ping-s -r - {example output} + $ ping 1.1.1.1 | jc --ping-s -r + {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"0","ttl":"56","time_ms":"23.054"} + {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"1","ttl":"56","time_ms":"24.739"} + {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"2","ttl":"56","time_ms":"23.232"} ... @@ -45,6 +69,12 @@ info() ``` Provides parser metadata (version, author, etc.) +## state +```python +state() +``` + + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/jc/parsers/ping_s.py b/jc/parsers/ping_s.py index 5b3926c8..dd5b1c18 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -16,7 +16,7 @@ Usage (module): Schema: { - "type": string, # 'reply', 'timeout', 'summary' + "type": string, # 'reply', 'timeout', 'summary', etc. See `_error_type.type_map` for all options. "source_ip": string, "destination_ip": string, "sent_bytes": integer,