1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/parsers/timedatectl.md
Kelly Brazil 1d0ad2f045 doc fixes
2021-01-04 18:01:16 -08:00

2.2 KiB

jc.parsers.timedatectl

jc - JSON CLI output utility timedatectl command output parser

Usage (cli):

$ timedatectl | jc --timedatectl

or

$ jc timedatectl

Usage (module):

import jc.parsers.timedatectl
result = jc.parsers.timedatectl.parse(timedatectl_command_output)

Compatibility:

'linux'

Examples:

$ timedatectl | jc --timedatectl -p
{
  "local_time": "Tue 2020-03-10 17:53:21 PDT",
  "universal_time": "Wed 2020-03-11 00:53:21 UTC",
  "rtc_time": "Wed 2020-03-11 00:53:21",
  "time_zone": "America/Los_Angeles (PDT, -0700)",
  "ntp_enabled": true,
  "ntp_synchronized": true,
  "rtc_in_local_tz": false,
  "dst_active": true
}

$ timedatectl | jc --timedatectl -p -r
{
  "local_time": "Tue 2020-03-10 17:53:21 PDT",
  "universal_time": "Wed 2020-03-11 00:53:21 UTC",
  "rtc_time": "Wed 2020-03-11 00:53:21",
  "time_zone": "America/Los_Angeles (PDT, -0700)",
  "ntp_enabled": "yes",
  "ntp_synchronized": "yes",
  "rtc_in_local_tz": "no",
  "dst_active": "yes"
}

info

info()

process

process(proc_data)

Final processing to conform to the schema.

Parameters:

proc_data:   (Dictionary) raw structured data to process

Returns:

Dictionary. Structured data with the following schema:

{
  "local_time":                        string,
  "universal_time":                    string,
  "rtc_time":                          string,
  "time_zone":                         string,
  "ntp_enabled":                       boolean,
  "ntp_synchronized":                  boolean,
  "system_clock_synchronized":         boolean,
  "systemd-timesyncd.service_active":  boolean,
  "rtc_in_local_tz":                   boolean,
  "dst_active":                        boolean
}

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:

Dictionary. Raw or processed structured data.